home *** CD-ROM | disk | FTP | other *** search
/ Precision Software Appli…tions Silver Collection 4 / Precision Software Applications Silver Collection Volume 4 (1993).iso / organise / ptm228c.arj / PHANTOM.DOC < prev    next >
Text File  |  1992-11-16  |  99KB  |  3,481 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                                   DOS PHANTOM
  16.  
  17.                                       V2.6
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.                              _______
  25.                         ____|__     |               (tm)
  26.                      --|       |    |-------------------
  27.                        |   ____|__  |  Association of
  28.                        |  |       |_|  Shareware
  29.                        |__|   o   |    Professionals
  30.                      -----|   |   |---------------------
  31.                           |___|___|    MEMBER
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.                                  P2 Enterprises
  39.                                   P.O. Box 25
  40.                            Ben Lomond, CA 95005-0025
  41.                      VoiceMail (408) 336-8080 mailbox 9090
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.                                 DOS Phantom V2.6
  55.             Copyright (c) 1992 P2 Enterprises   All Rights Reserved
  56.  
  57.  
  58.                                     - 1 -
  59.     DOS PHANTOM V2.6                                                Page 2
  60.                                                            20 September 92
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.                                        CONTENTS
  74.  
  75.  
  76.  
  77.     CHAPTER 1       INTRODUCTION
  78.  
  79.             1.1     WHAT IS DOS PHANTOM? . . . . . . . . . . . . . . . 1-1
  80.             1.2     WHAT IS DOS PHANTOM GOOD FOR?  . . . . . . . . . . 1-3
  81.  
  82.  
  83.     CHAPTER 2       NEW FEATURES ADDED IN VERSION 2.3, 2.4, 2.5, AND 2.6
  84.  
  85.  
  86.     CHAPTER 3       WHAT IS SHAREWARE?
  87.  
  88.  
  89.     CHAPTER 4       LICENSE, WARRANTY, REGISTRATION, AND SUPPORT
  90.  
  91.             4.1     LICENSE  . . . . . . . . . . . . . . . . . . . . . 4-1
  92.             4.2     REGISTRATION . . . . . . . . . . . . . . . . . . . 4-3
  93.             4.3     SUPPORT  . . . . . . . . . . . . . . . . . . . . . 4-4
  94.  
  95.  
  96.     CHAPTER 5       USING DOS PHANTOM
  97.  
  98.             5.1     BEFORE YOU BEGIN . . . . . . . . . . . . . . . . . 5-1
  99.             5.2     DOS PHANTOM'S COMMAND LINE . . . . . . . . . . . . 5-2
  100.             5.3     RECORDING AND PLAYING BACK . . . . . . . . . . . . 5-4
  101.             5.4     PAUSING  . . . . . . . . . . . . . . . . . . . . . 5-6
  102.             5.5     QUICK PLAYBACK . . . . . . . . . . . . . . . . . . 5-7
  103.             5.6     LOOPING PLAYBACK . . . . . . . . . . . . . . . . . 5-8
  104.             5.7     THE DOS PHANTOM CONTROL PANEL  . . . . . . . . . . 5-9
  105.             5.8     CHANGING THE HOT KEYS  . . . . . . . . . . . . .  5-10
  106.             5.9     MAKING DOS PHANTOM MEMORY RESIDENT . . . . . . .  5-12
  107.             5.10    REMOVING DOS PHANTOM FROM MEMORY . . . . . . . .  5-13
  108.             5.11    USING THE /O SWITCH  . . . . . . . . . . . . . .  5-14
  109.  
  110.  
  111.     CHAPTER 6       USING HOT KEYS TO START PLAYBACKS
  112.  
  113.  
  114.  
  115.  
  116.                                     - 2 -
  117.     DOS PHANTOM V2.6                                                Page 3
  118.                                                            20 September 92
  119.  
  120.  
  121.     CHAPTER 7       SCHEDULING RECORDINGS FOR LATER PLAYBACK
  122.  
  123.  
  124.     CHAPTER 8       CONVERTING ASCII TEXT FILES FOR PLAYBACK
  125.  
  126.  
  127.     CHAPTER 9       EDITING DOS PHANTOM RECORDINGS
  128.  
  129.             9.1     ELIMINATING HELP TEXT  . . . . . . . . . . . . . . 9-4
  130.             9.2     DOS PHANTOM DIRECTIVES . . . . . . . . . . . . . . 9-5
  131.             9.3     $PAUSE AND $WAIT - PROGRAMMED PAUSES . . . . . . . 9-5
  132.             9.4     $1 - $9 - SUBSTITUTION PARAMETERS  . . . . . . . . 9-7
  133.             9.5     COMPRESSED MODE  . . . . . . . . . . . . . . . . . 9-8
  134.             9.6     POP-UP DISPLAYS  . . . . . . . . . . . . . . . . . 9-9
  135.             9.7     LABELS AND THE $GOTO DIRECTIVE . . . . . . . . .  9-11
  136.             9.8     POP-UP MENUS . . . . . . . . . . . . . . . . . .  9-12
  137.             9.9     PROGRAMMED SCREEN CAPTURE  . . . . . . . . . . .  9-15
  138.             9.10    PROGRAMMED PRINT CAPTURE . . . . . . . . . . . .  9-16
  139.             9.11    PACING . . . . . . . . . . . . . . . . . . . . .  9-17
  140.             9.12    MATCHING SCREEN TEXT . . . . . . . . . . . . . .  9-18
  141.             9.13    WAITING FOR PROGRAM EXIT . . . . . . . . . . . .  9-20
  142.             9.14    DETECTING EXIT STATUS  . . . . . . . . . . . . .  9-21
  143.             9.15    USING THE $SETMODE DIRECTIVES  . . . . . . . . .  9-22
  144.             9.16    HINTS AND TIPS . . . . . . . . . . . . . . . . .  9-23
  145.             9.16.1    RECOVERING EDITING SESSIONS  . . . . . . . . .  9-23
  146.             9.16.2    USING DOS PHANTOM IN BATCH FILES . . . . . . .  9-23
  147.             9.16.3    PLAYBACK CHAINING  . . . . . . . . . . . . . .  9-23
  148.             9.16.4    DON'T USE THE MOUSE  . . . . . . . . . . . . .  9-23
  149.  
  150.  
  151.     CHAPTER 10      DOS PHANTOM TECHNICAL INFORMATION
  152.  
  153.             10.1    DOS VERSION REQUIREMENTS . . . . . . . . . . . .  10-1
  154.             10.2    MEMORY USAGE . . . . . . . . . . . . . . . . . .  10-1
  155.  
  156.  
  157.     CHAPTER 11      DIFFERENCES BETWEEN DOS PHANTOM V1.4 AND V2.0
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.                                     - 3 -
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.                                   CHAPTER 1
  188.  
  189.                                  INTRODUCTION
  190.  
  191.  
  192.  
  193.     1.1  WHAT IS DOS PHANTOM?
  194.  
  195.     DOS Phantom is a full-featured task  automator  which  can  perform  a
  196.     large  number  of functions to make life with your computer easier and
  197.     more efficient.
  198.  
  199.     DOS Phantom does the following:
  200.  
  201.           o  Records and plays back keystrokes either  with  the  original
  202.              delays between keystrokes or at high speed,
  203.  
  204.           o  Provides unlimited recording length (actually limited by  the
  205.              amount of available disk space).
  206.  
  207.           o  Allows the definition of up to 16 hot keys to start  playback
  208.              of specific recordings with a single keystroke.
  209.  
  210.           o  Allows  scheduling  of  playback  on  a  daily,  weekly,   or
  211.              once-only basis.
  212.  
  213.           o  Provides the ability to edit recordings,
  214.  
  215.           o  Provides the ability to add pop-up displays and pop-up  menus
  216.              to recordings,
  217.  
  218.           o  Provides the ability to wait during playback  for  a  certain
  219.              character sequence to appear on the screen,
  220.  
  221.           o  Provides the ability to wait during playback for a program to
  222.              exit  and  detect  whether  a  success  or  error  status was
  223.              returned,
  224.  
  225.           o  Captures the screen contents and writes it to a file  at  the
  226.              press  of  a  hot  key  or  as  directed by the contents of a
  227.              recording file,
  228.  
  229.  
  230.  
  231.  
  232.                                     - 4 -
  233.     INTRODUCTION                                                  Page 1-2
  234.     WHAT IS DOS PHANTOM?                                   20 September 92
  235.  
  236.  
  237.           o  Captures output destined for the printer and writes it  to  a
  238.              file (can be turned on and off from within a recording file),
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.                                     - 5 -
  291.     INTRODUCTION                                                  Page 1-3
  292.     WHAT IS DOS PHANTOM GOOD FOR?                          20 September 92
  293.  
  294.  
  295.     1.2  WHAT IS DOS PHANTOM GOOD FOR?
  296.  
  297.  
  298.           o  Recovery After System Crashes or Power Failures
  299.  
  300.              Because DOS Phantom writes your recorded  keystrokes  to  the
  301.              disk  after  every  32 keystrokes, if you were recording when
  302.              your system failed, you can just playback the recording file,
  303.              recovering  everything except perhaps the last 31 keystrokes.
  304.              This can be tremendously useful during long editing sessions,
  305.              eliminating  the need to periodically save your work to avoid
  306.              losing it in a system crash.
  307.  
  308.           o  A Batch Substitute
  309.  
  310.              DOS Phantom can be used  in  place  of  simple  batch  files,
  311.              eliminating  the  need  to  prepare  the  batch files with an
  312.              editor -- You just show DOS Phantom what you want  done,  and
  313.              DOS  Phantom can do it for you after that.  You can even edit
  314.              your DOS Phantom recordings if you make a mistake during  the
  315.              recording.   You  can  also  perform  parameter  substitution
  316.              similar to that available with MS-DOS batch files.
  317.  
  318.           o  Keystroke Macros
  319.  
  320.              Using  the  HOTFILE  program  (included  with  DOS  Phantom),
  321.              recording  files  can  be  assigned to hot keys, allowing the
  322.              entire recording to be played back with a  single  keystroke.
  323.              Up  to 16 hotkeys can be defined.  The hotkeys work even when
  324.              you're running a program.
  325.  
  326.           o  Program Startup
  327.  
  328.              DOS Phantom can be used  to  automatically  supply  input  to
  329.              programs  which  expect  to  receive keyboard input (programs
  330.              such as spreadsheets and others).  It can  thus  be  used  to
  331.              perform  a  sequence  of  "startup"  commands which you would
  332.              otherwise have to type each time you run the program.
  333.  
  334.           o  Automatic Execution
  335.  
  336.              You might record the keystrokes to run your spreadsheet, load
  337.              current stock quotes, print a graph, and exit.  You only have
  338.              to do it once; DOS Phantom can do it after that.  And you can
  339.              start it all with a single keystroke!
  340.  
  341.              DOS Phantom can be used to automate access to systems such as
  342.              Prodigy which normally require your presence at the keyboard.
  343.              Record the keystrokes that you use to dial Prodigy and  print
  344.              headline  news  and current stock quotations.  Then have your
  345.              computer wake up early and call Prodigy.  You  can  have  the
  346.  
  347.  
  348.                                     - 6 -
  349.     INTRODUCTION                                                  Page 1-4
  350.     WHAT IS DOS PHANTOM GOOD FOR?                          20 September 92
  351.  
  352.  
  353.              latest information printed and waiting for you to peruse with
  354.              your morning coffee.
  355.  
  356.           o  Demos
  357.  
  358.              DOS Phantom can be used create a  quick  demonstration  of  a
  359.              program which can then be played back at will for prospective
  360.              users or customers.  DOS Phantom can be paused  automatically
  361.              or manually during playback for discussion or manual entry of
  362.              data to the program being demonstrated.  In addition,  pop-up
  363.              windows  can be displayed to explain what is happening in the
  364.              demo, and menus can be presented to allow the user  to  guide
  365.              the course of the demo.
  366.  
  367.              Automatic timeouts when  user  response  is  required  and  a
  368.              looping   feature   allow  DOS  Phantom-based  demos  to  run
  369.              continuously and unattended and yet allow users  to  interact
  370.              with the demonstration if they wish.
  371.  
  372.           o  Software Testing
  373.  
  374.              DOS Phantom can be used to record tests of software which  is
  375.              undergoing  revision.   Then,  the tests can be run after the
  376.              revisions are complete to be  sure  what  worked  before  the
  377.              revisions  still works after the revisions.  Screens contents
  378.              can be written to a  file  at  strategic  points  during  the
  379.              execution  of  the program and printer output can be captured
  380.              as well.  This allows the output of the program  to  compared
  381.              with earlier test runs to detect differences.
  382.  
  383.           o  Applications Integration
  384.  
  385.              DOS Phantom can be used as the "glue" to marry  a  collection
  386.              of  disparate  programs  into  a  complete package to solve a
  387.              problem.   For  example,  the  shareware   product   QuickPro
  388.              Retriever uses DOS Phantom to automatically update investment
  389.              prices in Quicken (a finance management program from  Intuit)
  390.              with  information  from  Prodigy's on-line stock market quote
  391.              facility.  DOS Phantom's ability to search out  text  on  the
  392.              screen  and  verify termination status of programs gives it a
  393.              significant advantage over "blind playback"  utilities  which
  394.              blithely   continue   delivering  keystrokes  even  when  the
  395.              programs they are running have gone awry.
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.                                     - 7 -
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.                                   CHAPTER 2
  420.  
  421.              NEW FEATURES ADDED IN VERSION 2.3, 2.4, 2.5, AND 2.6
  422.  
  423.  
  424.  
  425.     Version  2.3  of  DOS  Phantom  added  support  for   the   PHANTOMDIR
  426.     environment variable, hot files, and playback scheduling:
  427.  
  428.           o  Use of PHANTOMDIR Environment Variable
  429.  
  430.              Starting  with  V2.3,  if  the   DOS   environment   variable
  431.              PHANTOMDIR  is  set  to define a disk and directory path, DOS
  432.              Phantom and the TXT2PTM and PTM2TXT  translators  will  store
  433.              recording  files  in the PHANTOMDIR directory.  You no longer
  434.              need to remember where a particular recording file is and you
  435.              no longer need to type in long pathnames when your default is
  436.              not the same as the location of the recording file.
  437.  
  438.              If PHANTOMDIR is not set,  DOS  Phantom  behaves  as  it  did
  439.              before,  searching  the default directory for recording files
  440.              unless otherwise instructed.
  441.  
  442.              To define PHANTOMDIR  as  C:\PHANTOM,  you  would  place  the
  443.              following line in your AUTOEXEC.BAT file:
  444.  
  445.                                 SET PHANTOMDIR=C:\PHANTOM
  446.  
  447.  
  448.              Should you wish to remove the environment variable,  use  the
  449.              following command:
  450.  
  451.                                 SET PHANTOMDIR=
  452.  
  453.  
  454.           o  Hot Files
  455.  
  456.              Hot files are recording files whose playback is initiated  by
  457.              the touch of a hot key.  This eliminates the need to bring up
  458.              the DOS Phantom Control Panel and type  in  the  filename  or
  459.              type in the PHANTOM2 play command at the DOS prompt.
  460.  
  461.  
  462.  
  463.  
  464.                                     - 8 -
  465.     NEW FEATURES ADDED IN VERSION 2.3, 2.4, 2.5, AND 2.6          Page 2-2
  466.                                                            20 September 92
  467.  
  468.  
  469.              The HOTFILE program, included in the DOS  Phantom  V2.4  kit,
  470.              allows  you  to  define 16 hot files and associated hot keys.
  471.              HOTFILE also allows you to list the defined hot files and hot
  472.              keys,  delete  hot key assignments, and display a list of the
  473.              valid hot keys.
  474.  
  475.              HOTFILE requires that the PHANTOMDIR environment variable  be
  476.              defined.
  477.  
  478.           o  Playback Scheduling
  479.  
  480.              Version 2.3 introduced the SCHEDULE program.  SCHEDULE allows
  481.              you  to  schedule  playback  of  up to 16 Phantom recordings.
  482.              Playback can be scheduled to occur on a  daily  basis,  on  a
  483.              weekly  basis, or one time only.  SCHEDULE also allows you to
  484.              list the current schedule and delete scheduled playbacks.
  485.  
  486.              Only files placed in the directory defined by the  PHANTOMDIR
  487.              environment variable may be scheduled.
  488.  
  489.  
  490.     Version 2.4 addressed the following bugs which were  present  in  V2.2
  491.     but which were reported after V2.3 was released:
  492.  
  493.           o  Characters  with  keyboard  scan   codes   under   10h   were
  494.              erroneously given timings of zero by PTM2TXT.
  495.  
  496.           o  Characters were lost in some recordings when typematic repeat
  497.              rates of over 15 characters per second were used.
  498.  
  499.  
  500.     Version 2.4 also includes  the  MAKEPTM  program  which  automatically
  501.     converts a text file so that it can be played back through DOS Phantom
  502.     as if it were being typed at the  keyboard.   MAKEPTM  allows  you  to
  503.     specify delay between characters and delay between lines.
  504.  
  505.     Version 2.5 corrects a problem with MAKEPTM which caused  errors  when
  506.     line  delays  of  zero  were specified and corrects a bug which caused
  507.     system  hangs  under   certain   circumstances   when   invalid   file
  508.     specifications were entered for playback.
  509.  
  510.     Version 2.5 also incorporates the capability to  invoke  Phantom  from
  511.     within  a  playback  to  "chain"  to another file.  Note that invoking
  512.     Phantom to begin recording from  within  a  playback  session  is  not
  513.     supported.
  514.  
  515.     Version 2.6 added  support  for  the  F11,  F12,  SHFT-F11,  SHFT-F12,
  516.     CTRL-F11,  CTRL-F12,  ALT-F11,  and ALT-F12 keys and fixed a bug which
  517.     caused corruption of the schedule file when recordings were made using
  518.     the default file RECORDNG.PTM.
  519.  
  520.  
  521.  
  522.                                     - 9 -
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.                                   CHAPTER 3
  536.  
  537.                               WHAT IS SHAREWARE?
  538.  
  539.  
  540.  
  541.     Shareware distribution gives users a chance  to  try  software  before
  542.     buying  it.  If you try a Shareware program and continue using it, you
  543.     are expected to register.  Individual programs differ  on  details  --
  544.     some  request  registration  while  others  require it, some specify a
  545.     maximum trial period.  With registration, you get  anything  from  the
  546.     simple right to continue using the software to an updated program with
  547.     printed manual.
  548.  
  549.     Copyright laws apply to both Shareware and  commercial  software,  and
  550.     the   copyright  holder  retains  all  rights,  with  a  few  specific
  551.     exceptions  as  stated  below.   Shareware  authors  are  accomplished
  552.     programmers,  just  like  commercial  authors, and the programs are of
  553.     comparable quality.  (In both cases, there are good programs  and  bad
  554.     ones!)  The  main  difference  is  in the method of distribution.  The
  555.     author specifically grants  the  right  to  copy  and  distribute  the
  556.     software,  either  to  all  and  sundry  or  to a specific group.  For
  557.     example, some authors require written permission before  a  commercial
  558.     disk vendor may copy their Shareware.
  559.  
  560.     Shareware is a distribution method,  not  a  type  of  software.   You
  561.     should  find  software  that  suits your needs and pocketbook, whether
  562.     it's commercial or Shareware.  The Shareware system makes fitting your
  563.     needs  easier,  because  you  can try before you buy.  And because the
  564.     overhead is low, prices are low  also.   Shareware  has  the  ultimate
  565.     money-back  guarantee  --  if you don't use the product, you don't pay
  566.     for it.
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.                                     - 10 -
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.                                   CHAPTER 4
  594.  
  595.                  LICENSE, WARRANTY, REGISTRATION, AND SUPPORT
  596.  
  597.  
  598.  
  599.     4.1  LICENSE
  600.  
  601.     DOS PHANTOM is not and has never been public domain software,  nor  is
  602.     it free software.
  603.  
  604.     Non-licensed users are granted a limited license to use DOS PHANTOM on
  605.     a  21-day  trial  basis  for  the  purpose  of determining whether DOS
  606.     PHANTOM is suitable for their needs.  The use of DOS  PHANTOM,  except
  607.     for  the  initial  21-day  trial,  requires  registration.  The use of
  608.     unlicensed copies of DOS PHANTOM by any person, business, corporation,
  609.     government agency or any other entity is strictly prohibited.
  610.  
  611.     A single user license permits a user to use  DOS  PHANTOM  only  on  a
  612.     single  computer.   Licensed  users  may  use the program on different
  613.     computers, but may not use the program on more than  one  computer  at
  614.     the same time.
  615.  
  616.     No one may modify or patch the DOS PHANTOM  executable  files  in  any
  617.     way,  including  but  not  limited  to  decompiling, disassembling, or
  618.     otherwise reverse engineering the program.
  619.  
  620.     A limited license is granted to copy and distribute DOS  PHANTOM  only
  621.     for  the  trial  use  of others, subject to the above limitations, and
  622.     also the following:
  623.  
  624.          1.  DOS PHANTOM must be copied in unmodified form, complete  with
  625.              the provided license and registration information.
  626.  
  627.          2.  The full machine-readable DOS PHANTOM documentation  must  be
  628.              included with each copy.
  629.  
  630.          3.  DOS PHANTOM may not be distributed in  conjunction  with  any
  631.              other  product  with  out a specific license to do so from P2
  632.              Enterprises.
  633.  
  634.  
  635.  
  636.  
  637.  
  638.                                     - 11 -
  639.     LICENSE, WARRANTY, REGISTRATION, AND SUPPORT                  Page 4-2
  640.     LICENSE                                                20 September 92
  641.  
  642.  
  643.          4.  No fee, charge, or other compensation  may  be  requested  or
  644.              accepted, except as authorized below:
  645.  
  646.               o  Operators of electronic bulletin board  systems  (sysops)
  647.                  may  make  DOS  PHANTOM available for downloading only as
  648.                  long as the above conditions  are  met.   An  overall  or
  649.                  time-dependent  charge  for the use of the bulletin board
  650.                  system is permitted as long as there is  not  a  specific
  651.                  charge for the download of DOS PHANTOM.
  652.  
  653.               o  Vendors of user-supported or shareware software  approved
  654.                  by  the  ASP  may  distribute DOS PHANTOM, subject to the
  655.                  above  conditions,  without  specific  permission.    Non
  656.                  approved  vendors  may  distribute DOS PHANTOM only after
  657.                  obtaining written permission from P2  Enterprises.   Such
  658.                  permission  is usually granted.  Please write for details
  659.                  (enclose  your  catalog).   Vendors  may  charge  a  disk
  660.                  duplication  and  handling  fee, which, when pro-rated to
  661.                  the DOS PHANTOM product, may not exceed eight dollars.
  662.  
  663.  
  664.  
  665.     LIMITED WARRANTY
  666.  
  667.     THIS PRODUCT IS LICENSED "AS IS" WITHOUT  ANY  WARRANTY  OF  ANY  KIND
  668.     INCLUDING,  BUT  NOT  LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY
  669.     AND FITNESS FOR A PARTICULAR  PURPOSE,  ALL  OF  WHICH  ARE  EXPRESSLY
  670.     DISCLAIMED.  SHOULD THE PROGRAM PROVE DEFECTIVE, THE PURCHASER ASSUMES
  671.     THE RISK OF PAYING THE ENTIRE COST OF ALL NECESSARY SERVICING, REPAIR,
  672.     OR  CORRECTION  AND  ANY  INCIDENTAL  OR CONSEQUENTIAL DAMAGES.  IN NO
  673.     EVENT WILL  P2  ENTERPRISES  BE  LIABLE  FOR  ANY  DAMAGES  WHATSOEVER
  674.     (INCLUDING  WITHOUT  LIMITATION  DAMAGES FOR LOSS OF BUSINESS PROFITS,
  675.     BUSINESS INTERRUPTION, LOSS OF  BUSINESS  INFORMATION  AND  THE  LIKE)
  676.     ARISING OUT OF THE USE OR THE INABILITY TO USE THIS PRODUCT EVEN IF P2
  677.     ENTERPRISES HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  678.  
  679.     Use of this product for any period of time constitutes your acceptance
  680.     of this agreement and subjects you to its contents.
  681.  
  682.     U.S.  GOVERNMENT RESTRICTED RIGHTS
  683.  
  684.     Use, duplication, or  disclosure  by  the  Government  is  subject  to
  685.     restrictions  as  set forth in subdivision (b)(3)(ii) of the Rights in
  686.     Technical  Data  and  Computer  Software   clause   at   252.227-7013.
  687.     Contractor/manufacturer  is  P2 Enterprises, P.O.  Box 25, Ben Lomond,
  688.     CA 95005-0025
  689.  
  690.     The information in this document is subject to change  without  notice
  691.     and does not represent a commitment on the part of P2 Enterprises.
  692.  
  693.  
  694.  
  695.  
  696.                                     - 12 -
  697.     LICENSE, WARRANTY, REGISTRATION, AND SUPPORT                  Page 4-3
  698.     REGISTRATION                                           20 September 92
  699.  
  700.  
  701.     4.2  REGISTRATION
  702.  
  703.     This program is shareware.  It is not free.  If, after  an  evaluation
  704.     period  of  21 days, you wish to continue using this program, you must
  705.     register by sending US$25.00 by check or postal money order to
  706.  
  707.                     DOS Phantom
  708.                     P2 Enterprises
  709.                     P.O. Box 25
  710.                     Ben Lomond, CA 95005-0025
  711.  
  712.  
  713.     In response, P2 Enterprises  will  send  you  a  personalized  Product
  714.     Registration  Key (PRK) which you can use with the P2 REGISTER program
  715.     to effect registration of this program.
  716.  
  717.     Registration suppresses the display of the statements requesting  that
  718.     you register.
  719.  
  720.     Registration  entitles  you  to  three  months  of  support  from   P2
  721.     Enterprises as described in the following section.
  722.  
  723.     Your Product Registration Key can be used to register future  versions
  724.     of this program at no additional cost.
  725.  
  726.     Licenses for unlimited use on a single LAN and licenses for commercial
  727.     distribution  of  this  product  as  part  of another product are also
  728.     available.  Contact P2 Enterprises for details.
  729.  
  730.  
  731.  
  732.  
  733.  
  734.  
  735.  
  736.  
  737.  
  738.  
  739.  
  740.  
  741.  
  742.  
  743.  
  744.  
  745.  
  746.  
  747.  
  748.  
  749.  
  750.  
  751.  
  752.  
  753.  
  754.                                     - 13 -
  755.     LICENSE, WARRANTY, REGISTRATION, AND SUPPORT                  Page 4-4
  756.     SUPPORT                                                20 September 92
  757.  
  758.  
  759.     4.3  SUPPORT
  760.  
  761.     Registered users receive three months of support from P2  Enterprises.
  762.     P2  Enterprises  will answer questions and fix serious bugs during the
  763.     three month support period.  P2 Enterprises may choose not to  attempt
  764.     a  fix  to  a  problem  involving  a  specific  hardware  or  software
  765.     environment or feature.  If this is the case, a  full  refund  of  the
  766.     registration fee will be made upon your request.
  767.  
  768.     P2 Enterprises may be reached via a VoiceMail system at  408  336-8080
  769.     mailbox 9090, or via CompuServe ID 70621,2475, or by US Mail at PO Box
  770.     25, Ben  Lomond  CA  95005-0025  USA.   The  VoiceMail  system  is  in
  771.     operation between the hours of 5AM and 5PM Pacific Time.
  772.  
  773.     P2  Enterprises  is  a  member  of  the   Association   of   Shareware
  774.     Professionals  (ASP).   ASP  wants  to  make  sure  that the shareware
  775.     principle  works  for  you.   If  you  are   unable   to   resolve   a
  776.     shareware-related  problem with an ASP member by contacting the member
  777.     directly, ASP may be able to help.  The ASP  Ombudsman  can  help  you
  778.     resolve  a dispute or problem with an ASP member, but does not provide
  779.     technical support for members' products.   Please  write  to  the  ASP
  780.     Ombudsman  at 545 Grover Road, Muskegon, MI 49442 or send a CompuServe
  781.     message via CompuServe Mail to ASP Ombudsman 70007,3536.
  782.  
  783.  
  784.  
  785.  
  786.  
  787.  
  788.  
  789.  
  790.  
  791.  
  792.  
  793.  
  794.  
  795.  
  796.  
  797.  
  798.  
  799.  
  800.  
  801.  
  802.  
  803.  
  804.  
  805.  
  806.  
  807.  
  808.  
  809.  
  810.  
  811.  
  812.                                     - 14 -
  813.  
  814.  
  815.  
  816.  
  817.  
  818.  
  819.  
  820.  
  821.  
  822.  
  823.  
  824.  
  825.                                   CHAPTER 5
  826.  
  827.                               USING DOS PHANTOM
  828.  
  829.  
  830.  
  831.     5.1  BEFORE YOU BEGIN
  832.  
  833.     Before using DOS Phantom, we recommend that you create a directory for
  834.     your  recording  files  and set the PHANTOMDIR environment variable to
  835.     point to it.  Assuming that you want to store your recording files  in
  836.     C:\PHANTOM,  here  is  the command to create the directory and set the
  837.     PHANTOMDIR environment variable appropriately:
  838.  
  839.                      C:\> MKDIR PHANTOM
  840.                      C:\> SET PHANTOMDIR=C:\PHANTOM
  841.  
  842.  
  843.     You should place the second command above in your AUTOEXEC.BAT file so
  844.     that PHANTOMDIR gets set each time you boot your computer.
  845.  
  846.     You may wish to place the DOS Phantom executable files  (PHANTOM2.EXE,
  847.     TXT2PTM.EXE,  PTM2TXT.PTM,  HOTFILE.EXE,  and SCHEDULE.EXE in the same
  848.     directory.  If you do this, add the PHANTOMDIR directory to  the  PATH
  849.     definition  in  your  AUTOEXEC.BAT file.  (You may change the names of
  850.     the .EXE files with the DOS REN command to  eliminate  conflicts  with
  851.     the names of other products or just to make them easier to type.)
  852.  
  853.     Once PHANTOMDIR is defined, DOS Phantom expects to place all recording
  854.     files  there.  You should not include disk or directory information in
  855.     the filenames you supply DOS Phantom for recordings.
  856.  
  857.  
  858.  
  859.  
  860.  
  861.  
  862.  
  863.  
  864.  
  865.  
  866.  
  867.  
  868.  
  869.  
  870.                                     - 15 -
  871.     USING DOS PHANTOM                                             Page 5-2
  872.     DOS PHANTOM'S COMMAND LINE                             20 September 92
  873.  
  874.  
  875.     5.2  DOS PHANTOM'S COMMAND LINE
  876.  
  877.     DOS Phantom accepts the following basic command line switches:
  878.  
  879.              /P Playback
  880.  
  881.              /R Record
  882.  
  883.              /Q Quick Playback
  884.  
  885.              /L Looping Playback
  886.  
  887.              /I Install as a Memory Resident Program
  888.  
  889.              /U Un-install DOS Phantom from memory
  890.  
  891.  
  892.     In addition, the following command line switches are also available:
  893.  
  894.              /K Attention Hot Key Selection
  895.  
  896.              /A Abort Hot Key Selection
  897.  
  898.              /D Screen Capture Hot Key
  899.  
  900.              /S Toggle Sounds
  901.  
  902.              /-S Disable Sounds
  903.  
  904.              /M Toggle Mode Display
  905.  
  906.              /-M Disable Mode Display
  907.  
  908.              /C Disable use of Color
  909.  
  910.              /O Include Screen Output Records in Recordings
  911.  
  912.              /V Print Capture File
  913.  
  914.              /F Screen Capture File Selection
  915.  
  916.              /Z Suppresses all  DOS  Phantom-generated  output  (copyright
  917.              notices, etc.)
  918.  
  919.  
  920.     Here's an example of a DOS Phantom  command  to  begin  recording  and
  921.     create the file RECORDNG.PTM:
  922.  
  923.                    C> PHANTOM2 /R RECORDNG.PTM
  924.  
  925.  
  926.  
  927.  
  928.                                     - 16 -
  929.     USING DOS PHANTOM                                             Page 5-3
  930.     DOS PHANTOM'S COMMAND LINE                             20 September 92
  931.  
  932.  
  933.     Here's the command to play back those keystrokes:
  934.  
  935.                    C> PHANTOM2 /P RECORDNG.PTM
  936.  
  937.  
  938.  
  939.  
  940.  
  941.  
  942.  
  943.  
  944.  
  945.  
  946.  
  947.  
  948.  
  949.  
  950.  
  951.  
  952.  
  953.  
  954.  
  955.  
  956.  
  957.  
  958.  
  959.  
  960.  
  961.  
  962.  
  963.  
  964.  
  965.  
  966.  
  967.  
  968.  
  969.  
  970.  
  971.  
  972.  
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.  
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.                                     - 17 -
  987.     USING DOS PHANTOM                                             Page 5-4
  988.     RECORDING AND PLAYING BACK                             20 September 92
  989.  
  990.  
  991.     5.3  RECORDING AND PLAYING BACK
  992.  
  993.     DOS Phantom normally creates  a  new  command  shell  when  you  start
  994.     recording.  DOS Phantom will record everything you type until you exit
  995.     the shell by typing EXIT at the DOS command prompt.  Here's an example
  996.     of recording a DIR command followed by a playback of the recording:
  997.  
  998.         Record the keystrokes:
  999.  
  1000.             C> PHANTOM2 /R RECORDNG.PTM
  1001.             DOS Phantom V2.6 123456  Copyright (c) 1992...blah...blah...
  1002.  
  1003.             Press ALT-P to pause or resume recording.
  1004.             Press ALT-P twice in succession to activate the control panel.
  1005.             Type EXIT at the DOS prompt when done.
  1006.  
  1007.  
  1008.             C> DIR
  1009.  
  1010.             ...blah blah blah...
  1011.  
  1012.             C> EXIT
  1013.             DOS Phantom terminated.
  1014.  
  1015.  
  1016.  
  1017.         Now play them back:
  1018.  
  1019.             C> PHANTOM2 /P RECORDING.PTM
  1020.             DOS Phantom V2.6 123456  Copyright (c) 1992...blah...blah...
  1021.  
  1022.             Press ALT-P to pause or resume playback.
  1023.             Press ALT-P twice in succession to activate the control panel.
  1024.             Type EXIT at the DOS prompt when done.
  1025.  
  1026.  
  1027.             C> DIR
  1028.  
  1029.             ...blah blah blah...
  1030.  
  1031.             C> EXIT
  1032.             DOS Phantom terminated.
  1033.  
  1034.             C>
  1035.  
  1036.  
  1037.     While DOS Phantom was running, it placed a small display in the  upper
  1038.     right  corner of the screen showing what it was doing.  In the example
  1039.     above, the display showed either "Record" or  "Play".   If  you  don't
  1040.     want the mode display, just include the /M switch on the command line,
  1041.     like this:
  1042.  
  1043.  
  1044.                                     - 18 -
  1045.     USING DOS PHANTOM                                             Page 5-5
  1046.     RECORDING AND PLAYING BACK                             20 September 92
  1047.  
  1048.  
  1049.             C> PHANTOM2 /P /M RECORDNG.PTM
  1050.  
  1051.  
  1052.     Note that the /M switch is a "toggle", meaning that if the feature  is
  1053.     on  it  is  turned  off,  and  if  it  is  off  it  is  turned on.  To
  1054.     unconditionally set the mode display off, use /-M.
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061.  
  1062.  
  1063.  
  1064.  
  1065.  
  1066.  
  1067.  
  1068.  
  1069.  
  1070.  
  1071.  
  1072.  
  1073.  
  1074.  
  1075.  
  1076.  
  1077.  
  1078.  
  1079.  
  1080.  
  1081.  
  1082.  
  1083.  
  1084.  
  1085.  
  1086.  
  1087.  
  1088.  
  1089.  
  1090.  
  1091.  
  1092.  
  1093.  
  1094.  
  1095.  
  1096.  
  1097.  
  1098.  
  1099.  
  1100.  
  1101.  
  1102.                                     - 19 -
  1103.     USING DOS PHANTOM                                             Page 5-6
  1104.     PAUSING                                                20 September 92
  1105.  
  1106.  
  1107.     5.4  PAUSING
  1108.  
  1109.     If you press the hot key (ALT-P unless you change it with  /K)  during
  1110.     record  or  playback,  after  a  brief  delay, DOS Phantom will play a
  1111.     series of tones falling in pitch to indicate its transition  to  PAUSE
  1112.     mode.  The mode display, if enabled, will change to "Pause".  A second
  1113.     depression  of  the  hot  key  resumes  the  recording  or   playback,
  1114.     accompanied  by a series of rising tones indicating the transition out
  1115.     of PAUSE mode.
  1116.  
  1117.     If you are playing back, playback stops while you are in  PAUSE  mode.
  1118.     If  you  are  recording,  the  keys  you  press  while  paused are not
  1119.     recorded, nor is the time which passes while in PAUSE mode recorded.
  1120.  
  1121.     You can disable the sounds by including  the  /S  switch  on  the  DOS
  1122.     Phantom command line, like this:
  1123.  
  1124.             C> PHANTOM2 /R /S RECORDNG.PTM
  1125.  
  1126.  
  1127.     Note that the /S switch is a "toggle", meaning that if the feature  is
  1128.     on  it  is  turned  off,  and  if  it  is  off  it  is  turned on.  To
  1129.     unconditionally set the sounds off, use /-S.
  1130.  
  1131.  
  1132.  
  1133.  
  1134.  
  1135.  
  1136.  
  1137.  
  1138.  
  1139.  
  1140.  
  1141.  
  1142.  
  1143.  
  1144.  
  1145.  
  1146.  
  1147.  
  1148.  
  1149.  
  1150.  
  1151.  
  1152.  
  1153.  
  1154.  
  1155.  
  1156.  
  1157.  
  1158.  
  1159.  
  1160.                                     - 20 -
  1161.     USING DOS PHANTOM                                             Page 5-7
  1162.     QUICK PLAYBACK                                         20 September 92
  1163.  
  1164.  
  1165.     5.5  QUICK PLAYBACK
  1166.  
  1167.     DOS Phantom normally plays back recordings at the same speed at  which
  1168.     they  were  recorded.  The /Q switch forces DOS Phantom to playback as
  1169.     quickly as possible.  Note that some programs "eat" characters if they
  1170.     are  delivered  too  fast.   DOS  Phantom's "demand playback" feature,
  1171.     introduced in V1.3, eliminates most problems in this  area,  but  some
  1172.     programs, notable Prodigy, may still eat characters occasionally.  For
  1173.     Prodigy and other programs which still appear to eat characters,  edit
  1174.     your   recording  to  use  the  $SetMode  Func6  and  $SetMode  Normal
  1175.     directives as described later in the section on  editing  DOS  Phantom
  1176.     recordings if you want to use quick playback.
  1177.  
  1178.     You can alter the intervals between individual keystrokes to speed  up
  1179.     some  sections  of  a  recording  and  slow down others by editing the
  1180.     recording  file.   See  the  section  below  on  editing  DOS  Phantom
  1181.     recordings.
  1182.  
  1183.  
  1184.  
  1185.  
  1186.  
  1187.  
  1188.  
  1189.  
  1190.  
  1191.  
  1192.  
  1193.  
  1194.  
  1195.  
  1196.  
  1197.  
  1198.  
  1199.  
  1200.  
  1201.  
  1202.  
  1203.  
  1204.  
  1205.  
  1206.  
  1207.  
  1208.  
  1209.  
  1210.  
  1211.  
  1212.  
  1213.  
  1214.  
  1215.  
  1216.  
  1217.  
  1218.                                     - 21 -
  1219.     USING DOS PHANTOM                                             Page 5-8
  1220.     LOOPING PLAYBACK                                       20 September 92
  1221.  
  1222.  
  1223.     5.6  LOOPING PLAYBACK
  1224.  
  1225.     If you supply the /L switch on the  command  line,  DOS  Phantom  will
  1226.     rewind  and play the same recording file over and over until you pause
  1227.     it by pressing the hot key.  If DOS Phantom  is  memory-resident  (see
  1228.     below), you must close the recording file to avoid the continuation of
  1229.     looping when you press the hot key  again.   If  DOS  Phantom  is  not
  1230.     memory-resident, then you must type EXIT at the DOS prompt.
  1231.  
  1232.     Looping can be a valuable tool in continuously-running  demonstrations
  1233.     or  in stress-testing software systems.  Not that looping playback may
  1234.     also be accomplished using the $Goto directive in the recording  file.
  1235.     See the section on editing recording files for more information.
  1236.  
  1237.  
  1238.  
  1239.  
  1240.  
  1241.  
  1242.  
  1243.  
  1244.  
  1245.  
  1246.  
  1247.  
  1248.  
  1249.  
  1250.  
  1251.  
  1252.  
  1253.  
  1254.  
  1255.  
  1256.  
  1257.  
  1258.  
  1259.  
  1260.  
  1261.  
  1262.  
  1263.  
  1264.  
  1265.  
  1266.  
  1267.  
  1268.  
  1269.  
  1270.  
  1271.  
  1272.  
  1273.  
  1274.  
  1275.  
  1276.                                     - 22 -
  1277.     USING DOS PHANTOM                                             Page 5-9
  1278.     THE DOS PHANTOM CONTROL PANEL                          20 September 92
  1279.  
  1280.  
  1281.     5.7  THE DOS PHANTOM CONTROL PANEL
  1282.  
  1283.     If you hit the hot key twice within about a half  second,  the  pop-up
  1284.     control panel is triggered, and is displayed over whatever was already
  1285.     on the screen.
  1286.  
  1287.     Note that if your screen is in graphics mode, the screen  may  not  be
  1288.     restored  to  its original condition when you leave the control panel,
  1289.     or the control panel may not appear at all.
  1290.  
  1291.     Here is what the control panel looks like:
  1292.  
  1293.             +----------------------------------------------------+
  1294.             |                    DOS Phantom                V2.6 |
  1295.             +----------------------------------------------------+
  1296.             |                                                    |
  1297.             |   +---------+ +---------+ +---------+ +--------+   |
  1298.             |   |         | |         | |         | |        |   |
  1299.             |   | PLAY    | | QPLAY   | | RECORD  | | CLOSE  |   |
  1300.             |   |         | |         | |         | |        |   |
  1301.             |   +---------+ +---------+ +---------+ +--------+   |
  1302.             |                                                    |
  1303.             |    Sound On     Mode Display On   Loop Mode Off    |
  1304.             |                                                    |
  1305.             |    Filename: RECORDNG.PTM                          |
  1306.             |                                                    |
  1307.             +----------------------------------------------------+
  1308.  
  1309.  
  1310.  
  1311.     You can highlight the selection of your choice using the  arrow,  tab,
  1312.     or  spacebar  keys and press RETURN to execute it or you can press the
  1313.     key corresponding to the first letter of your selection.
  1314.  
  1315.     If you press R, P, or Q, the  menu  is  immediately  erased,  and  DOS
  1316.     Phantom begins executing your command.  CLOSE closes an open recording
  1317.     file - This is the only way to close a recording file when DOS Phantom
  1318.     is memory-resident.  The Sound, Mode Display, and Loop Mode selections
  1319.     toggle the sounds, mode display, and looping on and off.
  1320.  
  1321.     Selecting Filename allows you to change the recording filename.   When
  1322.     you have finished entering the filename, press RETURN.
  1323.  
  1324.     Pressing the ESC key erases the menu without starting a  recording  or
  1325.     playback session.
  1326.  
  1327.  
  1328.  
  1329.  
  1330.  
  1331.  
  1332.  
  1333.  
  1334.                                     - 23 -
  1335.     USING DOS PHANTOM                                            Page 5-10
  1336.     CHANGING THE HOT KEYS                                  20 September 92
  1337.  
  1338.  
  1339.     5.8  CHANGING THE HOT KEYS
  1340.  
  1341.     There are three hot keys used by DOS Phantom.  By default, two of them
  1342.     are disabled (set to the key NONE).  The three hot keys are:
  1343.  
  1344.           o  The attention hot key
  1345.  
  1346.              This is by default set to Alt-P and  is  used  to  pause  and
  1347.              resume  recordings,  and  to cause display of the DOS Phantom
  1348.              control panel as described  earlier.   The  /K  command  line
  1349.              switch is used to change the attention hot key to another key
  1350.              or to disable it.
  1351.  
  1352.           o  The screen capture hot key
  1353.  
  1354.              This key is by default disabled.  When it is enabled with the
  1355.              /D  command,  pressing  it  at any time causes DOS Phantom to
  1356.              write a copy of the screen to the file specified with the  /F
  1357.              command  line  switch.  If no file was specified with /F, the
  1358.              default file SCREEN.TXT is used.
  1359.  
  1360.           o  The abort hot key
  1361.  
  1362.              The abort hot key, when enabled  with  the  /A  command  line
  1363.              switch   causes   immediate   termination  of  playback.   In
  1364.              addition, the abort key is passed on to the program which  is
  1365.              running  (or  the  DOS  command  processor  if  no program is
  1366.              running).  This is not true of the other hot keys -- they are
  1367.              "eaten"  by  DOS  Phantom.   The most common abort hot key is
  1368.              Ctrl-C.  This allows a single  keystroke  to  both  terminate
  1369.              playback and the program running.
  1370.  
  1371.  
  1372.     Here's how you would change the attention hot key to F10:
  1373.  
  1374.             C> PHANTOM2 /K=F10 /R RECORDNG.PTM
  1375.  
  1376.  
  1377.  
  1378.  
  1379.  
  1380.  
  1381.  
  1382.  
  1383.  
  1384.  
  1385.  
  1386.  
  1387.  
  1388.  
  1389.  
  1390.  
  1391.  
  1392.                                     - 24 -
  1393.     USING DOS PHANTOM                                            Page 5-11
  1394.     CHANGING THE HOT KEYS                                  20 September 92
  1395.  
  1396.  
  1397.     Here is a list of all the acceptable hot keys which  you  can  specify
  1398.     with /K, /D, and /A:
  1399.  
  1400.             SHFT-TAB        ALT-Q           ALT-W           ALT-E
  1401.             ALT-R           ALT-T           ALT-Y           ALT-U
  1402.             ALT-I           ALT-O           ALT-P           ALT-A
  1403.             ALT-S           ALT-D           ALT-F           ALT-G
  1404.             ALT-H           ALT-J           ALT-K           ALT-L
  1405.             ALT-Z           ALT-X           ALT-C           ALT-V
  1406.             ALT-B           ALT-N           ALT-M           F1
  1407.             F2              F3              F4              F5
  1408.             F6              F7              F8              F9
  1409.             F10             HOME            UP              PGUP
  1410.             LEFT            RIGHT           END             DOWN
  1411.             PGDWN           INSERT          DELETE          SHFT-F1
  1412.             SHFT-F2         SHFT-F3         SHFT-F4         SHFT-F5
  1413.             SHFT-F6         SHFT-F7         SHFT-F8         SHFT-F9
  1414.             SHFT-F10        CTRL-F1         CTRL-F2         CTRL-F3
  1415.             CTRL-F4         CTRL-F5         CTRL-F6         CTRL-F7
  1416.             CTRL-F8         CTRL-F9         CTRL-F10        ALT-F1
  1417.             ALT-F2          ALT-F3          ALT-F4          ALT-F5
  1418.             ALT-F6          ALT-F7          ALT-F8          ALT-F9
  1419.             ALT-F10         CTRL-LEFT       CTRL-RIGHT      CTRL-END
  1420.             CTRL-PGDWN      CTRL-HOME       ALT-1           ALT-2
  1421.             ALT-3           ALT-4           ALT-5           ALT-6
  1422.             ALT-7           ALT-8           ALT-9           ALT-0
  1423.             ALT--           ALT-=           CTRL-PGUP       CTRL-A
  1424.             CTRL-B          CTRL-C          CTRL-D          CTRL-E
  1425.             CTRL-F          CTRL-G          CTRL-H          CTRL-I
  1426.             CTRL-J          CTRL-K          CTRL-L          CTRL-M
  1427.             CTRL-N          CTRL-O          CTRL-P          CTRL-Q
  1428.             CTRL-R          CTRL-S          CTRL-T          CTRL-U
  1429.             CTRL-V          CTRL-W          CTRL-X          CTRL-Y
  1430.             CTRL-Z          ESC             F11             F12
  1431.             SHFT-F11        SHFT-F12        CTRL-F11        CTRL-F12
  1432.             ALT-F11         ALT-F12         NONE
  1433.  
  1434.  
  1435.  
  1436.  
  1437.  
  1438.  
  1439.  
  1440.  
  1441.  
  1442.  
  1443.  
  1444.  
  1445.  
  1446.  
  1447.  
  1448.  
  1449.  
  1450.                                     - 25 -
  1451.     USING DOS PHANTOM                                            Page 5-12
  1452.     MAKING DOS PHANTOM MEMORY RESIDENT                     20 September 92
  1453.  
  1454.  
  1455.     5.9  MAKING DOS PHANTOM MEMORY RESIDENT
  1456.  
  1457.     If you include the /I switch on the command line, DOS Phantom installs
  1458.     itself as a TSR (Terminate and Stay resident) program in memory.  This
  1459.     method of using DOS Phantom has a number of benefits.  Among them  are
  1460.     lower  memory  utilization because no command shell is invoked, faster
  1461.     execution because no loading of the DOS Phantom program  is  required,
  1462.     and the ability to begin and end recording and playback sessions while
  1463.     executing another program.
  1464.  
  1465.     Once resident, you access DOS Phantom by pressing the hot key twice in
  1466.     succession  to  trigger  the  pop-up  menu,  or by issuing DOS Phantom
  1467.     commands at the DOS prompt.
  1468.  
  1469.     You can install DOS Phantom in your  AUTOEXEC.BAT  file  by  including
  1470.     this command:
  1471.  
  1472.                     PHANTOM2 /I
  1473.  
  1474.  
  1475.  
  1476.  
  1477.  
  1478.  
  1479.  
  1480.  
  1481.  
  1482.  
  1483.  
  1484.  
  1485.  
  1486.  
  1487.  
  1488.  
  1489.  
  1490.  
  1491.  
  1492.  
  1493.  
  1494.  
  1495.  
  1496.  
  1497.  
  1498.  
  1499.  
  1500.  
  1501.  
  1502.  
  1503.  
  1504.  
  1505.  
  1506.  
  1507.  
  1508.                                     - 26 -
  1509.     USING DOS PHANTOM                                            Page 5-13
  1510.     REMOVING DOS PHANTOM FROM MEMORY                       20 September 92
  1511.  
  1512.  
  1513.     5.10  REMOVING DOS PHANTOM FROM MEMORY
  1514.  
  1515.     The /U switch un-installs DOS Phantom from memory.  When  you  execute
  1516.     the PHANTOM2/U command, one of two responses will be displayed:
  1517.  
  1518.          1.  DOS Phantom un-installed.
  1519.  
  1520.              This means that DOS Phantom was successfully un-installed.
  1521.  
  1522.          2.  DOS Phantom disabled.  Memory not reclaimed.
  1523.  
  1524.              This means that DOS Phantom was only disabled, and is dormant
  1525.              in  memory.  This is almost certainly because another TSR was
  1526.              loaded after DOS Phantom which intercepts some  of  the  same
  1527.              interrupts used by DOS Phantom.  To remove DOS Phantom, first
  1528.              remove any TSR's loaded after DOS Phantom, and then  re-issue
  1529.              the /U command.
  1530.  
  1531.  
  1532.  
  1533.  
  1534.  
  1535.  
  1536.  
  1537.  
  1538.  
  1539.  
  1540.  
  1541.  
  1542.  
  1543.  
  1544.  
  1545.  
  1546.  
  1547.  
  1548.  
  1549.  
  1550.  
  1551.  
  1552.  
  1553.  
  1554.  
  1555.  
  1556.  
  1557.  
  1558.  
  1559.  
  1560.  
  1561.  
  1562.  
  1563.  
  1564.  
  1565.  
  1566.                                     - 27 -
  1567.     USING DOS PHANTOM                                            Page 5-14
  1568.     USING THE /O SWITCH                                    20 September 92
  1569.  
  1570.  
  1571.     5.11  USING THE /O SWITCH
  1572.  
  1573.     The /O command line switch causes DOS Phantom to include  snippets  of
  1574.     screen  output in the recording file as comments.  This is provided to
  1575.     aid users  of  the  $MatchWait  directive  in  creating  "interactive"
  1576.     recordings.   The  use  of  /O significantly increases the size of the
  1577.     recording file and causes  many  more  disk  writes  to  occur  during
  1578.     recording.   Its  use  is  discouraged  except when you are creating a
  1579.     recording which you intend to edit to include  $MatchWait  directives.
  1580.     The  only  way  to  disable /O is to uninstall DOS Phantom with the /U
  1581.     switch if it was installed as a TSR or the  DOS  EXIT  command  if  it
  1582.     wasn't.
  1583.  
  1584.     See the chapter on editing DOS Phantom recordings for  information  on
  1585.     the $MatchWait and related directives.
  1586.  
  1587.  
  1588.  
  1589.  
  1590.  
  1591.  
  1592.  
  1593.  
  1594.  
  1595.  
  1596.  
  1597.  
  1598.  
  1599.  
  1600.  
  1601.  
  1602.  
  1603.  
  1604.  
  1605.  
  1606.  
  1607.  
  1608.  
  1609.  
  1610.  
  1611.  
  1612.  
  1613.  
  1614.  
  1615.  
  1616.  
  1617.  
  1618.  
  1619.  
  1620.  
  1621.  
  1622.  
  1623.  
  1624.                                     - 28 -
  1625.  
  1626.  
  1627.  
  1628.  
  1629.  
  1630.  
  1631.  
  1632.  
  1633.  
  1634.  
  1635.  
  1636.  
  1637.                                   CHAPTER 6
  1638.  
  1639.                       USING HOT KEYS TO START PLAYBACKS
  1640.  
  1641.  
  1642.  
  1643.     You can assign hot keys to recording files using the HOTFILE  program.
  1644.     Once  a  hot key is assigned to a recording file, pressing the hot key
  1645.     starts playback of the file, even if you are running  another  program
  1646.     at  the  time.   Of  course,  DOS Phantom must be installed before you
  1647.     press the hot key.
  1648.  
  1649.     HOTFILE accepts four commands:  ASSIGN, LIST, DELETE, and KEYS.
  1650.  
  1651.     The ASSIGN command lets you assign a hot key to a file.  The file must
  1652.     reside   in   the   directory  defined  by  the  environment  variable
  1653.     PHANTOMDIR.  Here's an example assigning the hot  key  CTRL-B  to  the
  1654.     recording file BACKUP.PTM:
  1655.  
  1656.                    C:\> HOTFILE ASSIGN CTRL-B BACKUP.PTM
  1657.  
  1658.  
  1659.     Here's an example of the LIST command:
  1660.  
  1661.                   C:\> HOTFILE LIST
  1662.                   HOTFILE V2.6 123456 Copyright (c) blah, blah, blah...
  1663.  
  1664.                   No    Hotkey       Playback file
  1665.                   --------------------------------
  1666.                    1    ALT-F10      MAIL.PTM
  1667.                    1    CTRL-B       BACKUP.PTM       
  1668.                    1    ALT-D        DIAL.PTM
  1669.  
  1670.  
  1671.     You can delete a hot key assignment with the DELETE command like this:
  1672.  
  1673.                   C:\> HOTFILE DELETE CTRL-B
  1674.                   HOTFILE V2.6 123456 Copyright (c) blah, blah, blah...
  1675.  
  1676.                   Delete assignment of CTRL-B to file BACKUP.PTM (Y)? y
  1677.  
  1678.                   C:\>
  1679.  
  1680.  
  1681.  
  1682.                                     - 29 -
  1683.     USING HOT KEYS TO START PLAYBACKS                             Page 6-2
  1684.                                                            20 September 92
  1685.  
  1686.  
  1687.     The KEYS command displays a list of the hot  keys  you  can  use  with
  1688.     HOTFILE.   If  you  type  HOTFILE  without a command, a help screen is
  1689.     displayed.
  1690.  
  1691.     After you make changes to the hot key assignments, you do not need  to
  1692.     unload  and  reload  DOS  Phantom  in order for the hot keys to become
  1693.     usable.  If DOS Phantom is already installed in memory when HOTFILE is
  1694.     run, HOTFILE communicates the changes to DOS Phantom.
  1695.  
  1696.     A maximum of 16 hot key assignments may be made.
  1697.  
  1698.     All of the commands may be abbreviated to a single character.
  1699.  
  1700.     The hot key assignments are stored in a file called HOTKEYS.DAT in the
  1701.     PHANTOMDIR  directory.   You  should  not  attempt to modify this file
  1702.     using any program other than HOTFILE.  If you delete  this  file,  all
  1703.     your hot key assignments will be lost.
  1704.  
  1705.  
  1706.  
  1707.  
  1708.  
  1709.  
  1710.  
  1711.  
  1712.  
  1713.  
  1714.  
  1715.  
  1716.  
  1717.  
  1718.  
  1719.  
  1720.  
  1721.  
  1722.  
  1723.  
  1724.  
  1725.  
  1726.  
  1727.  
  1728.  
  1729.  
  1730.  
  1731.  
  1732.  
  1733.  
  1734.  
  1735.  
  1736.  
  1737.  
  1738.  
  1739.  
  1740.                                     - 30 -
  1741.  
  1742.  
  1743.  
  1744.  
  1745.  
  1746.  
  1747.  
  1748.  
  1749.  
  1750.  
  1751.  
  1752.  
  1753.                                   CHAPTER 7
  1754.  
  1755.                    SCHEDULING RECORDINGS FOR LATER PLAYBACK
  1756.  
  1757.  
  1758.  
  1759.     The SCHEDULE program allows you to maintain a schedule  of  playbacks.
  1760.     Up to 16 schedule items may be created.  Playbacks may be scheduled on
  1761.     a daily, weekly, or once-only basis.   The  SCHEDULE  program  accepts
  1762.     commands  similar  to those of the HOTFILE program:  ASSIGN, LIST, and
  1763.     DELETE.
  1764.  
  1765.     The ASSIGN command assigns a playback time to a recording file.   (The
  1766.     recording  file  must  be  present  in  the  directory  defined by the
  1767.     environment variable PHANTOMDIR.) Here are some examples of the ASSIGN
  1768.     command:
  1769.  
  1770.          Play REMINDER.PTM every day at 11:30 am:
  1771.  
  1772.                  C:\> SCHEDULE ASSIGN 11:30 REMINDER.PTM
  1773.  
  1774.          Play WKLYBKUP.PTM every Friday at 10:00 pm:
  1775.  
  1776.                  C:\> SCHEDULE ASSIGN Fri-22:00 WKLYBKUP.PTM
  1777.  
  1778.          Play GETMAIL.PTM at 3:00pm on September 20, 1993:
  1779.  
  1780.                  C:\> SCHEDULE ASSIGN 9/20/93-15:00 GETMAIL.PTM
  1781.  
  1782.  
  1783.     Note that the times use a 24-hour clock and that the dash is  required
  1784.     between  the  day  of the week or the date and the time.  Here are the
  1785.     abbreviations for the days of the week which SCHEDULE recognizes:
  1786.              
  1787.             Sun Mon Tue Wed Thu Fri Sat
  1788.  
  1789.  
  1790.     Here are the pm hours of the 24-hour clock:
  1791.  
  1792.        noon 12       3pm 15       6pm 18         9pm 21        midnight 00
  1793.        1pm  13       4pm 16       7pm 19        10pm 22        1am       1
  1794.        2pm  14       5pm 17       8pm 20        11pm 23        2am       2
  1795.  
  1796.  
  1797.  
  1798.                                     - 31 -
  1799.     SCHEDULING RECORDINGS FOR LATER PLAYBACK                      Page 7-2
  1800.                                                            20 September 92
  1801.  
  1802.  
  1803.     Here is an example of the LIST command:
  1804.  
  1805.                  C:\> SCHEDULE LIST
  1806.                  SCHEDULE V2.6 922300 Copyright (c) 1992 blah, blah, blah...
  1807.  
  1808.                  No    When             Playback file
  1809.                  ------------------------------------
  1810.                   1    11:30            REMINDER.PTM
  1811.                   2    Fri-22:00        WKLYBKUP.PTM
  1812.                   3    9/20/93-15:00    GETMAIL.PTM    
  1813.  
  1814.  
  1815.     To remove an item from the schedule, use  SCHEDULE's  DELETE  command,
  1816.     specifying the date and time of the item to remove, like this:
  1817.  
  1818.                   C:\> SCHEDULE DELETE Fri-22:00
  1819.  
  1820.  
  1821.     After you make changes to the schedule, you do not need to unload  and
  1822.     reload  DOS  Phantom in order for the changes to become effective.  If
  1823.     DOS Phantom is already installed  in  memory  when  SCHEDULE  is  run,
  1824.     SCHEDULE communicates the changes to DOS Phantom.
  1825.  
  1826.     All of the commands may be abbreviated to a single character.
  1827.  
  1828.     The schedule information is stored in a file  called  SCHEDULE.DAT  in
  1829.     the  PHANTOMDIR directory.  You should not attempt to modify this file
  1830.     using any program other than SCHEDULE.  If you delete this  file,  the
  1831.     entire schedule will be lost.
  1832.  
  1833.  
  1834.  
  1835.  
  1836.  
  1837.  
  1838.  
  1839.  
  1840.  
  1841.  
  1842.  
  1843.  
  1844.  
  1845.  
  1846.  
  1847.  
  1848.  
  1849.  
  1850.  
  1851.  
  1852.  
  1853.  
  1854.  
  1855.  
  1856.                                     - 32 -
  1857.  
  1858.  
  1859.  
  1860.  
  1861.  
  1862.  
  1863.  
  1864.  
  1865.  
  1866.  
  1867.  
  1868.  
  1869.                                   CHAPTER 8
  1870.  
  1871.                    CONVERTING ASCII TEXT FILES FOR PLAYBACK
  1872.  
  1873.  
  1874.  
  1875.     The program MAKEPTM accepts as input any ASCII text file and  produces
  1876.     as  output a DOS Phantom recording file which, when played back, makes
  1877.     it appear as if the contents of the ASCII text file were  being  typed
  1878.     in at the keyboard.
  1879.  
  1880.     MAKEPTM allows you  to  specify  the  delay  in  milliseconds  between
  1881.     successive  characters  and  the  delay  in seconds between successive
  1882.     lines of text.  If you leave off the delay times, delays of  zero  are
  1883.     used.
  1884.  
  1885.     Here are some examples of MAKEPTM:
  1886.  
  1887.             Convert LETTER.TXT to LETTER.PTM:
  1888.  
  1889.                 C:\>MAKEPTM LETTER.TXT LETTER.PTM
  1890.  
  1891.  
  1892.             Convert LETTER.TXT to LETTER.PTM with 100 ms delay between
  1893.             characters:
  1894.  
  1895.                 C:\>MAKEPTM LETTER.TXT LETTER.PTM 100
  1896.  
  1897.  
  1898.             Convert LETTER.TXT to LETTER.PTM with 100 ms delay between
  1899.             characters and 2 seconds between lines:
  1900.  
  1901.                 C:\>MAKEPTM LETTER.TXT LETTER.PTM 100 2
  1902.  
  1903.  
  1904.             Convert LETTER.TXT to LETTER.PTM with no delay between
  1905.             characters, but a 2 second delay between lines:
  1906.  
  1907.                 C:\>MAKEPTM LETTER.TXT LETTER.PTM 0 2
  1908.  
  1909.  
  1910.  
  1911.  
  1912.  
  1913.  
  1914.                                     - 33 -
  1915.     CONVERTING ASCII TEXT FILES FOR PLAYBACK                      Page 8-2
  1916.                                                            20 September 92
  1917.  
  1918.  
  1919.     The output file can be played back like  any  DOS  Phantom  recording.
  1920.     Note  that  when  a  character  delay  has  been  specified, it is not
  1921.     possible to interrupt the recording with the attention hot key.
  1922.  
  1923.     MAKEPTM places its output file in the directory designated by the  DOS
  1924.     environment variable PHANTOMDIR if it is defined.
  1925.  
  1926.  
  1927.  
  1928.  
  1929.  
  1930.  
  1931.  
  1932.  
  1933.  
  1934.  
  1935.  
  1936.  
  1937.  
  1938.  
  1939.  
  1940.  
  1941.  
  1942.  
  1943.  
  1944.  
  1945.  
  1946.  
  1947.  
  1948.  
  1949.  
  1950.  
  1951.  
  1952.  
  1953.  
  1954.  
  1955.  
  1956.  
  1957.  
  1958.  
  1959.  
  1960.  
  1961.  
  1962.  
  1963.  
  1964.  
  1965.  
  1966.  
  1967.  
  1968.  
  1969.  
  1970.  
  1971.  
  1972.                                     - 34 -
  1973.  
  1974.  
  1975.  
  1976.  
  1977.  
  1978.  
  1979.  
  1980.  
  1981.  
  1982.  
  1983.  
  1984.  
  1985.                                   CHAPTER 9
  1986.  
  1987.                         EDITING DOS PHANTOM RECORDINGS
  1988.  
  1989.  
  1990.  
  1991.     The program PTM2TXT extracts information from a DOS Phantom  recording
  1992.     and  places  it  in  a  text  file for editing.  Here is an example of
  1993.     PTM2TXT:
  1994.  
  1995.             C> PTM2TXT RECORDNG.PTM RECORDNG.TXT
  1996.  
  1997.  
  1998.     The output text file looks like this:
  1999.  
  2000.     !========================================================================
  2001.     ! DOS Phantom V1.0
  2002.     !
  2003.     ! Text translation of recording file SAMPLE.KEY.
  2004.     ! Translated by PTM2TXT V2.6 999999.
  2005.     !
  2006.     ! Line format:
  2007.     !     mm:ss.ttt keystroke   eeaa ff
  2008.     !
  2009.     !     mm:ss:ttt = time interval between the previous keystroke and
  2010.     !                 this one.
  2011.     !         mm    = minutes
  2012.     !         ss    = seconds
  2013.     !         ttt   = thousandths of seconds
  2014.     !     ee        = extended keycode       (optional)
  2015.     !     aa        = ASCII code             (optional)
  2016.     !     ff        = keyboard status flags  (optional)
  2017.     !
  2018.     !     The optional fields need not be entered when editing this file.
  2019.     !     Values appropriate for most circumstances will be provided for
  2020.     !     you by TXT2PTM.  If you include values for the optional fields,
  2021.     !     Your values will override those which TXT2PTM would provide.
  2022.     !     You should delete the optional fields when changing the keystroke.
  2023.     !
  2024.     !     Comment lines (lines beginning with !) and empty lines are ignored
  2025.     !     by the TXT2PTM translator.
  2026.     !
  2027.     !     Lines beginning with an asterisk (*) are processed by TXT2PTM
  2028.  
  2029.  
  2030.                                     - 35 -
  2031.     EDITING DOS PHANTOM RECORDINGS                                Page 9-2
  2032.                                                            20 September 92
  2033.  
  2034.  
  2035.     !     without timing information.  This allows you to place entire
  2036.     !     commands on one line rather than one character per line. A
  2037.     !     carriage return is automatically placed at the end of * lines
  2038.     !     by TXT2PTM unless the last character on the line is a dollar
  2039.     !     sign.  Special character expressions (e.g., <Ctrl-K>) are
  2040.     !     delimited with angle brackets (<,>).
  2041.     !
  2042.     !     DOS Phantom directives begin with a dollar sign ($).
  2043.     !     Directives supported by DOS Phantom V2.6 are:
  2044.     !
  2045.     !       $n                     Input parameters (n=1-9)
  2046.     !       $Pause [n]             n=secs, default is no auto resume
  2047.     !       $Wait mm:ss.ttt        mm=min, ss=secs, ttt=ms
  2048.     !
  2049.     !       $BeginDisplay row col attr timo S|R
  2050.     !       $Title text            Display title (optional)
  2051.     !       <text>                 Text for pop-up display
  2052.     !       <text>                 More text lines...
  2053.     !       $EndDisplay            Display text between Begin and EndDisplay
  2054.     !
  2055.     !       $BeginMenu row col attr timo S|R
  2056.     !       $Title text            Menu title (optional)
  2057.     !       <lines of text>        Static (non-selectable) menu text
  2058.     !       $<label> itemtext      Go to <label> when item is selected.
  2059.     !       $<label> itemtext      More menu items...
  2060.     !       $EndMenu               Ends a menu definition
  2061.     !
  2062.     !       $Goto <label>          Continue execution at <label>
  2063.     !       $<label>:              Goto, Menu, or If target
  2064.     !       $ExitWait [n]          Wait n secs for program exit
  2065.     !       $IfSuccess <label>     Go to <label> if exit status = 0
  2066.     !       $IfError               Go to <label> if exit status <> 0
  2067.     !       $MatchWait n text      Wait n secs for text to appear on screen
  2068.     !       $IfMatch <label>       Go to <label> if match found
  2069.     !       $IfTimeout <label>     Go to <label> if no match found
  2070.     !       $Screen "text" [file]  Write screen to file prefixed with text
  2071.     !       $Printer C [file]      Capture printer output in file
  2072.     !       $Printer N             Return to normal printer output
  2073.     !
  2074.     !     See the DOS Phantom Users Guide for details on using these directives.
  2075.     !
  2076.     !     The special characters $, <, and > must be preceded by a
  2077.     !     dollar sign ($) when they are present in an asterisk line.
  2078.     !     Otherwise TXT2PTM will attempt to perform special processing
  2079.     !     erroneously.
  2080.     !
  2081.     !========================================================================
  2082.  
  2083.     00:01.430 D            2044 60
  2084.     00:00.165 I            1749 60
  2085.     00:00.165 R            1352 60
  2086.  
  2087.  
  2088.                                     - 36 -
  2089.     EDITING DOS PHANTOM RECORDINGS                                Page 9-3
  2090.                                                            20 September 92
  2091.  
  2092.  
  2093.     00:00.605 /            352f 60
  2094.     00:00.220 W            1157 60
  2095.     $1
  2096.     00:00.605 <CR>         1c0d 20
  2097.     00:07.480 e            1265 20
  2098.     00:00.000 x            2d78 20
  2099.     00:00.000 i            1769 20
  2100.     00:00.000 t            1474 20
  2101.     00:00.000 <CR>         1c0d 20
  2102.     $Pause
  2103.     00:00.000 <CR>         1c0d 20
  2104.  
  2105.  
  2106.     The above file depicts a recording of the commands "DIR/W" and "EXIT".
  2107.     As you can see, the carriage return character is translated to <CR> in
  2108.     the file.  Spaces are translated as <SP>.   Non-printing  and  special
  2109.     characters  such  as CTRL-K are all translated in this manner.  If you
  2110.     are not sure what the translation of a character might be, it is  best
  2111.     to  make  a  recording containing the character and then translate the
  2112.     recording with PTM2TXT to find out what the correct translation is.
  2113.  
  2114.     The line format is as described in the output file  shown  above.   If
  2115.     you  change  a  line  in  the  file,  it  is  best, unless you clearly
  2116.     understand the BIOS extended keycodes and keyboard  status  flags,  to
  2117.     remove the eeaa and ff fields.  TXT2PTM will supply appropriate values
  2118.     when you leave them out.
  2119.  
  2120.     Note that if you edit a translated DOS  Phantom  recording  files  and
  2121.     insert  comments  and  labels,  then  translate  the  text  file  to a
  2122.     recording file and back into a text file, the comments and labels will
  2123.     be  lost.   PTM2TXT  will  create labels required by the menu and goto
  2124.     directives in the recording, but they will not be the labels from your
  2125.     original  edited  text  file.   Goto and menu directives are discussed
  2126.     below.
  2127.  
  2128.     When you have finished editing, you can create a recording file  using
  2129.     the TXT2PTM program like this:
  2130.  
  2131.             C> TXT2PTM RECORDNG.TXT RECORDNG.PTM
  2132.  
  2133.  
  2134.  
  2135.  
  2136.  
  2137.  
  2138.  
  2139.  
  2140.  
  2141.  
  2142.  
  2143.  
  2144.  
  2145.  
  2146.                                     - 37 -
  2147.     EDITING DOS PHANTOM RECORDINGS                                Page 9-4
  2148.     ELIMINATING HELP TEXT                                  20 September 92
  2149.  
  2150.  
  2151.     9.1  ELIMINATING HELP TEXT
  2152.  
  2153.     If you don't want the detailed help header in the PTM2TXT output file,
  2154.     you  can specify the /H switch on the command line.  This will cause a
  2155.     brief header to  be  prefixed  to  the  translation  rather  than  the
  2156.     detailed help text shown in the above example.  For example:
  2157.  
  2158.             C> PTM2TXT /H RECORDNG.PTM RECORDNG.TXT
  2159.  
  2160.  
  2161.     Note that the switches to the PTM2TXT command must be  separated  from
  2162.     the PTM2TXT command and other switches by spaces.
  2163.  
  2164.  
  2165.  
  2166.  
  2167.  
  2168.  
  2169.  
  2170.  
  2171.  
  2172.  
  2173.  
  2174.  
  2175.  
  2176.  
  2177.  
  2178.  
  2179.  
  2180.  
  2181.  
  2182.  
  2183.  
  2184.  
  2185.  
  2186.  
  2187.  
  2188.  
  2189.  
  2190.  
  2191.  
  2192.  
  2193.  
  2194.  
  2195.  
  2196.  
  2197.  
  2198.  
  2199.  
  2200.  
  2201.  
  2202.  
  2203.  
  2204.                                     - 38 -
  2205.     EDITING DOS PHANTOM RECORDINGS                                Page 9-5
  2206.     DOS PHANTOM DIRECTIVES                                 20 September 92
  2207.  
  2208.  
  2209.     9.2  DOS PHANTOM DIRECTIVES
  2210.  
  2211.     DOS Phantom directives are directions to DOS Phantom that  you  insert
  2212.     into  a  recording  to  have  DOS  Phantom  perform some action during
  2213.     playback.  All directives begin with a $.  With the exception  of  the
  2214.     $1  -  $9 directives, all directives must begin at the first character
  2215.     position on a line.  Each directive is discussed in detail below.
  2216.  
  2217.  
  2218.  
  2219.     9.3  $PAUSE AND $WAIT - PROGRAMMED PAUSES
  2220.  
  2221.     The example above contains a  programmed  pause  directive  after  the
  2222.     second  <CR>.   Note  that programmed pauses (i.e., pauses which occur
  2223.     automatically at predetermined points during  playback)  may  only  be
  2224.     created  by  preparing  an  input  file for TXT2PTM such as that shown
  2225.     above.  There is no way to create programmed pauses  while  recording.
  2226.     The  pause  directive  may be followed by a timeout value expressed in
  2227.     seconds.  If the timeout period passes without a key being  depressed,
  2228.     the  pause  is ended and playback resumes.  Each time a key is pressed
  2229.     during the pause, the pause timer is restarted.
  2230.  
  2231.     The $Wait directive is also available.  $Wait accepts the time to wait
  2232.     in  mm:ss.ttt  format instead of in seconds like $Pause.  $Wait cannot
  2233.     be terminated by pressing a key as can $Pause, and unlike  $Pause  the
  2234.     playback  clock  continues  to run during a $Wait.  This can cause the
  2235.     characters following a $Wait to be played back  as  fast  as  possible
  2236.     until  the  playback  catches  up  (makes  up for the time lost in the
  2237.     $Wait).  $Wait directives are most  useful  in  recordings  which  are
  2238.     meant to be played back at high speed (e.g., files in compressed mode,
  2239.     described later), but where pauses without allowing keyboard input are
  2240.     required.
  2241.  
  2242.     To create the effect of a  $Wait  in  a  file  with  timed  keystrokes
  2243.     without  losing  time  during the wait, just add time to the keystroke
  2244.     which follows the wait.
  2245.  
  2246.     Here is a $Wait which will cause a wait of 3 minutes  and  10  seconds
  2247.     (this  will cause timed keystrokes following to be played back at high
  2248.     speed until the 3 minutes and 10 seconds are made up for):
  2249.  
  2250.                       $Wait 03:10.000
  2251.  
  2252.  
  2253.     Here is a keystroke which will not be played back until 3 minutes  and
  2254.     10 seconds have passed (no speedup of succeeding keystrokes occurs):
  2255.  
  2256.                       03:10.000 <CR>
  2257.  
  2258.  
  2259.  
  2260.  
  2261.  
  2262.                                     - 39 -
  2263.     EDITING DOS PHANTOM RECORDINGS                                Page 9-6
  2264.     $PAUSE AND $WAIT - PROGRAMMED PAUSES                   20 September 92
  2265.  
  2266.  
  2267.     In general, you use $Pause to pause for keyboard input, and  $Wait  in
  2268.     compressed recordings to stall without keyboard input.
  2269.  
  2270.  
  2271.  
  2272.  
  2273.  
  2274.  
  2275.  
  2276.  
  2277.  
  2278.  
  2279.  
  2280.  
  2281.  
  2282.  
  2283.  
  2284.  
  2285.  
  2286.  
  2287.  
  2288.  
  2289.  
  2290.  
  2291.  
  2292.  
  2293.  
  2294.  
  2295.  
  2296.  
  2297.  
  2298.  
  2299.  
  2300.  
  2301.  
  2302.  
  2303.  
  2304.  
  2305.  
  2306.  
  2307.  
  2308.  
  2309.  
  2310.  
  2311.  
  2312.  
  2313.  
  2314.  
  2315.  
  2316.  
  2317.  
  2318.  
  2319.  
  2320.                                     - 40 -
  2321.     EDITING DOS PHANTOM RECORDINGS                                Page 9-7
  2322.     $1 - $9 - SUBSTITUTION PARAMETERS                      20 September 92
  2323.  
  2324.  
  2325.     9.4  $1 - $9 - SUBSTITUTION PARAMETERS
  2326.  
  2327.     The example also contains a  substitution  parameter  directive:   $1.
  2328.     This  directive  causes the first parameter entered on the DOS Phantom
  2329.     command line after the filename to be substituted for  the  $1  during
  2330.     playback.   Up  to  nine substitution parameters ($1, $2, $3, ..., $9)
  2331.     may be used.   If  a  corresponding  command  line  parameter  is  not
  2332.     supplied  for playback, the parameter used on the previous playback is
  2333.     used.  If no parameter was used on the previous playback, or  if  this
  2334.     is  the  first  playback  of  this  DOS  Phantom  session,  nothing is
  2335.     substituted for the substitution parameter (i.e., it is as if  it  was
  2336.     not there).
  2337.  
  2338.     Multiple  substitution  parameter  directives  may  be  placed  in  an
  2339.     asterisk  line.   Otherwise,  only  a  single directive is allowed per
  2340.     line.  Asterisk lines and compressed mode are discussed  in  the  next
  2341.     section.
  2342.  
  2343.     If you have placed substitution parameter directives in your recording
  2344.     file you may pass the values to be substituted for them on the command
  2345.     line after the filename.  Here is an example  passing  the  parameters
  2346.     A:, XYZ, and BOOBOO:
  2347.  
  2348.            C> PHANTOM2/Q/I/K=F1 RECORDNG.PTM A: XYZ BOOBOO
  2349.  
  2350.  
  2351.     A:  is substituted for $1, XYZ for $2, and BOOBOO for $3.
  2352.  
  2353.  
  2354.  
  2355.  
  2356.  
  2357.  
  2358.  
  2359.  
  2360.  
  2361.  
  2362.  
  2363.  
  2364.  
  2365.  
  2366.  
  2367.  
  2368.  
  2369.  
  2370.  
  2371.  
  2372.  
  2373.  
  2374.  
  2375.  
  2376.  
  2377.  
  2378.                                     - 41 -
  2379.     EDITING DOS PHANTOM RECORDINGS                                Page 9-8
  2380.     COMPRESSED MODE                                        20 September 92
  2381.  
  2382.  
  2383.     9.5  COMPRESSED MODE
  2384.  
  2385.     You may avoid typing in the time fields (mm:ss.ttt) by starting  lines
  2386.     with  an asterisk.  Lines starting with an asterisk are referred to as
  2387.     being in "compressed" mode.  When TXT2PTM  processes  lines  beginning
  2388.     with  an  asterisk,  it behaves as if each character was on a separate
  2389.     line and preceded with "00:00.000".  TXT2PTM automatically  inserts  a
  2390.     <CR>  at  the  end of each * line.  You can suppress the automatically
  2391.     added <CR> by ending the asterisk line with a $.
  2392.  
  2393.     Here is the previous example created using this technique:
  2394.  
  2395.     !
  2396.     ! Example of the use of * lines.
  2397.     !
  2398.  
  2399.     * DIR/W $1
  2400.     $Pause
  2401.     * EXIT
  2402.     *
  2403.  
  2404.     !
  2405.     ! End of example
  2406.     !
  2407.  
  2408.  
  2409.     You can place substitution parameter directives anywhere in a asterisk
  2410.     line.   The  characters "<", ">", and "$" must be preceded with a $ if
  2411.     you don't want don't want DOS Phantom to handle them  specially.   For
  2412.     example, if I wanted DOS Phantom to play "Hello, World" followed by an
  2413.     Alt-F5 and then "The amount <is> $2.00." without a carriage return  at
  2414.     the end, I would use the following asterisk line:
  2415.  
  2416.             * Hello, World<Alt-F5>The amount $<is$> $$2.00.$
  2417.  
  2418.  
  2419.     You can mix compressed and non-compressed modes in the same text file.
  2420.  
  2421.     You can cause PTM2TXT to produce  compressed  mode  output  from  your
  2422.     recordings by including the /C switch on the command line like this:
  2423.  
  2424.             C> PTM2TXT /C RECORDNG.PTM RECORDNG.TXT
  2425.  
  2426.  
  2427.     Note that the switches to the PTM2TXT command must be  separated  from
  2428.     the PTM2TXT command and other switches by spaces.
  2429.  
  2430.  
  2431.  
  2432.  
  2433.  
  2434.  
  2435.  
  2436.                                     - 42 -
  2437.     EDITING DOS PHANTOM RECORDINGS                                Page 9-9
  2438.     POP-UP DISPLAYS                                        20 September 92
  2439.  
  2440.  
  2441.     9.6  POP-UP DISPLAYS
  2442.  
  2443.     You can cause windows containing text you provide  to  pop  up  during
  2444.     playbacks  of  DOS  Phantom  recordings.   These  pop-up  displays can
  2445.     contain text explaining what the user is seeing  in  a  demonstration,
  2446.     announce  a  that  a  certain  operation  is  about  to take place, or
  2447.     instruct the user to perform some action.
  2448.  
  2449.     When a pop-up display is displayed, playback is halted until the  user
  2450.     presses  any  key  or  until  a  timeout  period which you specify has
  2451.     elapsed.
  2452.  
  2453.     The text which you wish to  appear  in  a  pop-up  display  is  placed
  2454.     between  two  DOS  Phantom directives:  $BeginDisplay and $EndDisplay.
  2455.     If you want a title to appear in the upper left border of  the  pop-up
  2456.     display,  you may include a $Title directive on the line following the
  2457.     $BeginDisplay directive.
  2458.  
  2459.     The $BeginDisplay directive takes the following form:
  2460.  
  2461.            $BeginDisplay row col attr timo sr
  2462.  
  2463.  
  2464.     The parameters following the directive are interpreted as follows:
  2465.  
  2466.              row - the screen row on which the top pop-up display is to be
  2467.              written.
  2468.  
  2469.              col - the screen column on which the left edge of the  pop-up
  2470.              display is to be written.
  2471.  
  2472.              attr - The display attributes to be used for display of  your
  2473.              text:
  2474.  
  2475.                Attribute  Monochrome Display   Color Display
  2476.                ---------  ------------------   -----------------------
  2477.                    0      Normal               Gray on Blue
  2478.                    1      Bold                 White on Blue
  2479.                    2      Reverse Video        Dark Gray on Light Gray
  2480.                    3      Reverse Bold         Black on Light Gray
  2481.                    8      Normal               Normal
  2482.                    9      Bold                 Bold
  2483.  
  2484.  
  2485.              timo - A timeout value in seconds.   If  the  timeout  period
  2486.              passes  without  keyboard  input,  the  display is erased and
  2487.              playback resumes.  The maximum timeout value is 3600  seconds
  2488.              (1 hour).
  2489.  
  2490.  
  2491.  
  2492.  
  2493.  
  2494.                                     - 43 -
  2495.     EDITING DOS PHANTOM RECORDINGS                               Page 9-10
  2496.     POP-UP DISPLAYS                                        20 September 92
  2497.  
  2498.  
  2499.              sr - The character S or R indicating whether you  wish  other
  2500.              DOS  Phantom  displays  and menus which may be present on the
  2501.              screen to be erased  before  this  window  is  displayed.   R
  2502.              restores  the  screen  to  what it was before any DOS Phantom
  2503.              displays or menus were popped-up.  S saves the screen  as  it
  2504.              is  and  causes  the  new display to be painted over anything
  2505.              currently shown on the screen.
  2506.  
  2507.              DOS Phantom pop-up displays  are  automatically  erased  when
  2508.              playback is resumed.
  2509.  
  2510.  
  2511.     The text you wish to appear in the pop-up display  is  placed  between
  2512.     the $BeginDisplay and $EndDisplay directives.
  2513.  
  2514.     Here is an example of the directives used to create a pop-up display:
  2515.  
  2516.             !
  2517.             ! Create a display at row 5, column 20, reverse video, 2-minute
  2518.             ! timeout and erase any currently displayed pop-ups.
  2519.             !
  2520.             $BeginDisplay 5 20 2 120 R
  2521.             $Title Sample Pop-Up Display
  2522.  
  2523.             This is just a simple example of a
  2524.                  DOS Phantom pop-up display.
  2525.  
  2526.                (Press any key to continue.)
  2527.             $EndDisplay
  2528.  
  2529.  
  2530.     Here's how the above pop-up display would appear on the screen (at row
  2531.     5, column 20):
  2532.  
  2533.             +--Sample Pop-Up Display---------------+
  2534.             |                                      |
  2535.             |  This is just a simple example of a  |
  2536.             |       DOS Phantom pop-up display.    |
  2537.             |                                      |
  2538.             |     (Press any key to continue.      |
  2539.             +--------------------------------------+
  2540.  
  2541.  
  2542.     Note that when you specify the row and  column  for  the  display  you
  2543.     should  take into account that DOS Phantom will add 3 columns-worth of
  2544.     border to each line and an extra line at the top and  bottom  for  the
  2545.     border.
  2546.  
  2547.  
  2548.  
  2549.  
  2550.  
  2551.  
  2552.                                     - 44 -
  2553.     EDITING DOS PHANTOM RECORDINGS                               Page 9-11
  2554.     LABELS AND THE $GOTO DIRECTIVE                         20 September 92
  2555.  
  2556.  
  2557.     9.7  LABELS AND THE $GOTO DIRECTIVE
  2558.  
  2559.     You can cause playback to transfer from one place in a recording  file
  2560.     to  another  by  using the $Goto directive.  The $Goto directive has a
  2561.     single parameter:  the label of the location from which playback is to
  2562.     continue.  Labels in DOS Phantom recording files take the form
  2563.  
  2564.             $<text>:
  2565.  
  2566.  
  2567.     where <test> is any printable text string not starting  with  a  digit
  2568.     and not containing spaces or tabs.
  2569.  
  2570.     Here is an example of a recording which continually clears the  screen
  2571.     and the displays the current directory:
  2572.  
  2573.             !
  2574.             ! Endless loop directory
  2575.             !
  2576.             $Loop:
  2577.             * CLS
  2578.             * DIR /W
  2579.             $Goto Loop
  2580.  
  2581.  
  2582.  
  2583.     Note that the colon following the label is not included when the label
  2584.     is the parameter of the $Goto directive.
  2585.  
  2586.     The $Goto is most useful for returning to  a  pop-up  menu  after  the
  2587.     actions  requested  by  the user have been carried out.  (Pop-up menus
  2588.     are described in the next section.)
  2589.  
  2590.  
  2591.  
  2592.  
  2593.  
  2594.  
  2595.  
  2596.  
  2597.  
  2598.  
  2599.  
  2600.  
  2601.  
  2602.  
  2603.  
  2604.  
  2605.  
  2606.  
  2607.  
  2608.  
  2609.  
  2610.                                     - 45 -
  2611.     EDITING DOS PHANTOM RECORDINGS                               Page 9-12
  2612.     POP-UP MENUS                                           20 September 92
  2613.  
  2614.  
  2615.     9.8  POP-UP MENUS
  2616.  
  2617.     You can cause  menus  to  pop  up  during  playbacks  of  DOS  Phantom
  2618.     recordings.   These pop-up menus can contain text and items from which
  2619.     the user may choose.  Once an item is selected,  playback  resumes  at
  2620.     the  place  in  the  recording file which is associated with that menu
  2621.     selection.
  2622.  
  2623.     When a pop-up menu is displayed, playback is  halted  until  the  user
  2624.     selects  an  item  or  until  a  timeout  period which you specify has
  2625.     elapsed.
  2626.  
  2627.     The text and selection items which you wish to appear in a pop-up menu
  2628.     are  placed  between  two  DOS  Phantom  directives:   $BeginMenu  and
  2629.     $EndMenu.  If you want a title to appear in the upper left  border  of
  2630.     the  pop-up  menu,  you  may  include  a  $Title directive on the line
  2631.     following the $BeginMenu directive.
  2632.  
  2633.     The $BeginMenu directive takes the following form:
  2634.  
  2635.            $BeginMenu row col attr timo sr
  2636.  
  2637.  
  2638.     The parameters following the directive are interpreted as follows:
  2639.  
  2640.              row - the screen row on which the top pop-up menu  is  to  be
  2641.              written.
  2642.  
  2643.              col - the screen column on which the left edge of the  pop-up
  2644.              menu is to be written.
  2645.  
  2646.              attr - The display attributes to be used for display of  your
  2647.              text:
  2648.  
  2649.                Attribute  Monochrome Display   Color Display
  2650.                ---------  ------------------   -----------------------
  2651.                    0      Normal               Gray on Blue
  2652.                    1      Bold                 White on Blue
  2653.                    2      Reverse Video        Dark Gray on Light Gray
  2654.                    3      Reverse Bold         Black on Light Gray
  2655.                    8      Normal               Normal
  2656.                    9      Bold                 Bold
  2657.  
  2658.  
  2659.              timo - A timeout value in seconds.   If  the  timeout  period
  2660.              passes  without  keyboard  input,  the  display is erased and
  2661.              playback resumes.  The maximum timeout value is 3600  seconds
  2662.              (1 hour).
  2663.  
  2664.  
  2665.  
  2666.  
  2667.  
  2668.                                     - 46 -
  2669.     EDITING DOS PHANTOM RECORDINGS                               Page 9-13
  2670.     POP-UP MENUS                                           20 September 92
  2671.  
  2672.  
  2673.              sr - The character S or R indicating whether you  wish  other
  2674.              DOS  Phantom  displays  and menus which may be present on the
  2675.              screen to be erased  before  this  window  is  displayed.   R
  2676.              restores  the  screen  to  what it was before any DOS Phantom
  2677.              displays or menus were popped-up.  S saves the screen  as  it
  2678.              is  and  causes  the  new display to be painted over anything
  2679.              currently shown on the screen.
  2680.  
  2681.              DOS  Phantom  pop-up  menus  are  automatically  erased  when
  2682.              playback is resumed.
  2683.  
  2684.  
  2685.     Menu selection items are placed after the $BeginMenu and the  optional
  2686.     $Title  directives  and after any introductory text you wish to appear
  2687.     above the selection items in the menu window.   Menu  selection  items
  2688.     are  prefixed by $<label> where <label> is the label at which playback
  2689.     is to be resumed (or at which another display or menu is  defined)  if
  2690.     that  menu item is chosen.  Labels are described in the section on the
  2691.     $Goto directive.
  2692.  
  2693.     Here is an example of the directives used to create a pop-up menu:
  2694.  
  2695.             !
  2696.             ! Create a menu at row 5, column 20, reverse video, 10-second
  2697.             ! timeout and retain any currently displayed pop-ups.
  2698.             !
  2699.             $START:
  2700.  
  2701.             $BeginMenu 5 20 2 10 S
  2702.             $Title Sample Pop-Up Menu
  2703.  
  2704.             Choose one of the items below
  2705.             by moving the highlight bar
  2706.             with the arrow keys and pressing
  2707.             RETURN when the item you want
  2708.             is highlighted.
  2709.  
  2710.             $DIR    Directory
  2711.             $CLEAR  Clear Screen
  2712.             $QUIT   Quit
  2713.             $EndMenu
  2714.  
  2715.             $DIR:
  2716.             * dir/w
  2717.             $Goto start
  2718.  
  2719.             $CLEAR:
  2720.             * cls
  2721.             $Goto start
  2722.  
  2723.             $QUIT:
  2724.  
  2725.  
  2726.                                     - 47 -
  2727.     EDITING DOS PHANTOM RECORDINGS                               Page 9-14
  2728.     POP-UP MENUS                                           20 September 92
  2729.  
  2730.  
  2731.             * exit
  2732.  
  2733.  
  2734.     Here's how the above pop-up menu would appear on the screen (at row 5,
  2735.     column 20):
  2736.  
  2737.             +--Sample Pop-Up Menu----------------+
  2738.             |                                    |
  2739.             |  Choose one of the items below     |
  2740.             |  by moving the highlight bar       |
  2741.             |  with the arrow keys and pressing  |
  2742.             |  RETURN when the item you want     |
  2743.             |  is highlighted.                   |
  2744.             |                                    |
  2745.             |  Directory                         |
  2746.             |  Clear Screen                      |
  2747.             |  Quit                              |
  2748.             +------------------------------------+
  2749.  
  2750.  
  2751.     Note that when you specify the row and column for the menu you  should
  2752.     take  into account that DOS Phantom will add 3 columns-worth of border
  2753.     to each line and an extra line at the top and bottom for the border.
  2754.  
  2755.  
  2756.  
  2757.  
  2758.  
  2759.  
  2760.  
  2761.  
  2762.  
  2763.  
  2764.  
  2765.  
  2766.  
  2767.  
  2768.  
  2769.  
  2770.  
  2771.  
  2772.  
  2773.  
  2774.  
  2775.  
  2776.  
  2777.  
  2778.  
  2779.  
  2780.  
  2781.  
  2782.  
  2783.  
  2784.                                     - 48 -
  2785.     EDITING DOS PHANTOM RECORDINGS                               Page 9-15
  2786.     PROGRAMMED SCREEN CAPTURE                              20 September 92
  2787.  
  2788.  
  2789.     9.9  PROGRAMMED SCREEN CAPTURE
  2790.  
  2791.     The $Screen directive can be included in a recording file to cause the
  2792.     contents  of  the  screen  to be written to a file.  You may specify a
  2793.     line of text to appear before each screen in the file, and the name of
  2794.     the file.
  2795.  
  2796.     The $Screen directive takes the following form:
  2797.  
  2798.                 $Screen "text" file
  2799.  
  2800.  
  2801.     The text must be placed  between  quotation  marks.   It  is  used  to
  2802.     separate  a  series  of  screens  written  to the same file.  The file
  2803.     parameter is optional.  If it is not present, the file  SCREEN.TXT  in
  2804.     the current default directory is used.  If the file, whether specified
  2805.     or defaulted, is not present, it is created.  If it  is  present,  the
  2806.     current  contents  of  the screen are appended to the file prefixed by
  2807.     the specified text line.
  2808.  
  2809.     Note that screen capture can also be controlled using the  /D  and  /F
  2810.     command line switches described earlier.
  2811.  
  2812.  
  2813.  
  2814.  
  2815.  
  2816.  
  2817.  
  2818.  
  2819.  
  2820.  
  2821.  
  2822.  
  2823.  
  2824.  
  2825.  
  2826.  
  2827.  
  2828.  
  2829.  
  2830.  
  2831.  
  2832.  
  2833.  
  2834.  
  2835.  
  2836.  
  2837.  
  2838.  
  2839.  
  2840.  
  2841.  
  2842.                                     - 49 -
  2843.     EDITING DOS PHANTOM RECORDINGS                               Page 9-16
  2844.     PROGRAMMED PRINT CAPTURE                               20 September 92
  2845.  
  2846.  
  2847.     9.10  PROGRAMMED PRINT CAPTURE
  2848.  
  2849.     The $Printer  directive  allows  you  to  direct  output  which  would
  2850.     normally go to a printer to a file.  You can turn the print capture on
  2851.     and off and specify  the  file  to  which  printer  output  is  to  be
  2852.     directed.
  2853.  
  2854.     The $Printer directive takes the following form:
  2855.  
  2856.                $Printer C file
  2857.             
  2858.                     or
  2859.  
  2860.                $Printer N
  2861.  
  2862.  
  2863.     The $Printer C (for Capture) directive enables print  capture.   If  a
  2864.     file  is  specified,  printer  output is directed to that file.  If no
  2865.     file is specified, the default is PRINTER.TXT.  The  $Printer  N  (for
  2866.     Normal)  command  disables print capture and printer output once again
  2867.     is sent to the printer.
  2868.  
  2869.     Note that print capture can also be enabled with the /V  command  line
  2870.     switch.
  2871.  
  2872.  
  2873.  
  2874.  
  2875.  
  2876.  
  2877.  
  2878.  
  2879.  
  2880.  
  2881.  
  2882.  
  2883.  
  2884.  
  2885.  
  2886.  
  2887.  
  2888.  
  2889.  
  2890.  
  2891.  
  2892.  
  2893.  
  2894.  
  2895.  
  2896.  
  2897.  
  2898.  
  2899.  
  2900.                                     - 50 -
  2901.     EDITING DOS PHANTOM RECORDINGS                               Page 9-17
  2902.     PACING                                                 20 September 92
  2903.  
  2904.  
  2905.     9.11  PACING
  2906.  
  2907.     The  $SetPace  directive  allows  you  to  specify   the   number   of
  2908.     milliseconds  which are to elapse between successive keystrokes during
  2909.     playback.  This can be useful if you find a compressed  or  /Q-invoked
  2910.     playback is overrunning a programs capability of accepting input.
  2911.  
  2912.     The $SetPace directive takes the following form:
  2913.  
  2914.                 $SetPace ms
  2915.  
  2916.  
  2917.     Where ms is the number of milliseconds between keystrokes.  The actual
  2918.     delay is rounded to the nearest 55-millisecond boundary as that is the
  2919.     default resolution of the PC's clock.  You  can  disable  pacing  with
  2920.     $SetPace 0.
  2921.  
  2922.                                      NOTE
  2923.  
  2924.             Playback of recordings using  the  $SetPace  directive
  2925.             can  not  be  interrupted using the attention hot key.
  2926.             Once started, they must play to completion.
  2927.  
  2928.  
  2929.  
  2930.  
  2931.  
  2932.  
  2933.  
  2934.  
  2935.  
  2936.  
  2937.  
  2938.  
  2939.  
  2940.  
  2941.  
  2942.  
  2943.  
  2944.  
  2945.  
  2946.  
  2947.  
  2948.  
  2949.  
  2950.  
  2951.  
  2952.  
  2953.  
  2954.  
  2955.  
  2956.  
  2957.  
  2958.                                     - 51 -
  2959.     EDITING DOS PHANTOM RECORDINGS                               Page 9-18
  2960.     MATCHING SCREEN TEXT                                   20 September 92
  2961.  
  2962.  
  2963.     9.12  MATCHING SCREEN TEXT
  2964.  
  2965.     The directive $MatchWait is used to cause a playback to pause until  a
  2966.     text  string  you  specify  appears  on  the screen or until a timeout
  2967.     period you specify has passed.  The $IfMatch and $IfTimeout directives
  2968.     allow  you to determine whether a preceding $MatchWait directive ended
  2969.     with a timeout or a match and goto a  label  in  your  recording  file
  2970.     depending on which occurred.
  2971.  
  2972.     The $MatchWait directive takes the following form:
  2973.  
  2974.                 $MatchWait timo text
  2975.  
  2976.  
  2977.     Where timo is the timeout period in  seconds  and  text  is  the  text
  2978.     string to look for on the screen.  The text string may contain spaces,
  2979.     and the special characters <, >, and $ need not be prefixed with  a  $
  2980.     as is the case elsewhere in recording files.
  2981.  
  2982.     The $IfMatch and $IfTimeout take a single parameter:  the label to  go
  2983.     to if a match or timeout occurred, respectively.
  2984.  
  2985.     Here is an example of a recording file segment which  executes  a  DOS
  2986.     DIR  command  and  then  waits 10 seconds for the DOS prompt to appear
  2987.     before continuing and issuing an EXIT command.
  2988.  
  2989.                     * DIR
  2990.                     $MatchWait 10 C:\>
  2991.                     * EXIT
  2992.  
  2993.  
  2994.     Here is a more complex example using $IfTimeout.  This example  issues
  2995.     <CR>  characters until the word "Username:" appears on the screen.  It
  2996.     then issues the name BILLSMITH and waits for the word  "Password:"  to
  2997.     appear.  If "Password:" does not appear within 5 seconds, it goes back
  2998.     to sending <CR>'s and waiting for "Username:"
  2999.  
  3000.                     $LOOP:
  3001.                     * <CR>$
  3002.  
  3003.                     $MatchWait 3 "Username:"
  3004.                     $IfMatch CONTINUE
  3005.                     $Goto LOOP
  3006.  
  3007.                     $CONTINUE:
  3008.                     * BILLSMITH
  3009.                     $MatchWait 5 "Password:"
  3010.                     $IfTimeout RETRY
  3011.                     
  3012.  
  3013.  
  3014.  
  3015.  
  3016.                                     - 52 -
  3017.     EDITING DOS PHANTOM RECORDINGS                               Page 9-19
  3018.     MATCHING SCREEN TEXT                                   20 September 92
  3019.  
  3020.  
  3021.     The above is overly complex -- in particular, the $IfMatch followed by
  3022.     the  $Goto  and  the  CONTINUE  label  could all be replaced with just
  3023.     $IfTimeout LOOP.  It is shown the way it is so that all the directives
  3024.     described in this section could be used.
  3025.  
  3026.     Note that $MatchWait searches the entire screen for a match, not  just
  3027.     what  was output since the last keystroke.  You need to make sure that
  3028.     the text string you are waiting for isn't already on  the  screen,  or
  3029.     your $MatchWait will appear to terminate prematurely.
  3030.  
  3031.     Also note that $MatchWait is case-sensitive.  That is, $MatchWait does
  3032.     not  treat "Username" and "username" as a match.  The letters must the
  3033.     same case (upper or lower) for a match to occur.
  3034.  
  3035.     The /O switch is provided to assist you in  creating  recording  files
  3036.     using  the $MatchWait directive.  /O causes recent screen output to be
  3037.     included in recording files as comments.  You can edit these  comments
  3038.     into  $MatchWait directives without having to remember what was on the
  3039.     screen when you recorded the session.  The /O-captured output  is  far
  3040.     from  perfect,  and frequently may not be what is really needed in the
  3041.     $MatchWaits.  Alternatively, you can use the /D command line switch to
  3042.     enable  a  screen  capture  hot  key and capture the important screens
  3043.     during recording and then refer to them when inserting your $MatchWait
  3044.     directives.   Remember that the /O switch creates significant overhead
  3045.     and should only be used when needed.
  3046.  
  3047.  
  3048.  
  3049.  
  3050.  
  3051.  
  3052.  
  3053.  
  3054.  
  3055.  
  3056.  
  3057.  
  3058.  
  3059.  
  3060.  
  3061.  
  3062.  
  3063.  
  3064.  
  3065.  
  3066.  
  3067.  
  3068.  
  3069.  
  3070.  
  3071.  
  3072.  
  3073.  
  3074.                                     - 53 -
  3075.     EDITING DOS PHANTOM RECORDINGS                               Page 9-20
  3076.     WAITING FOR PROGRAM EXIT                               20 September 92
  3077.  
  3078.  
  3079.     9.13  WAITING FOR PROGRAM EXIT
  3080.  
  3081.     The $ExitWait directive causes a playback to pause until the next  DOS
  3082.     program exits.  This allows you to run a program, turn control over to
  3083.     the keyboard, and resume playback as soon as  the  program  ends.   An
  3084.     optional timeout value allows you to resume playback after a number of
  3085.     seconds without keystrokes has passed.
  3086.  
  3087.     The form of the $ExitWait directive is as follows:
  3088.  
  3089.                     $ExitWait n
  3090.  
  3091.  
  3092.     Where n is the number  of  seconds  to  wait  before  continuing  with
  3093.     playback if no keystrokes are detected.
  3094.  
  3095.     You can use the $IfTimeout directive to determine whether a  $ExitWait
  3096.     directive terminated because it timed out or because of program exit.
  3097.  
  3098.     Here is an example of running a program called TROJAN and waiting  for
  3099.     program  exit  or 1 minute without keystrokes.  If a timeout occurs, a
  3100.     CTRL-C character is delivered to the program to  terminate  it  before
  3101.     continuing.
  3102.  
  3103.                     * TROJAN
  3104.                     $ExitWait 60
  3105.                     $IfTimeout TERMINATE
  3106.  
  3107.                     $CONTINUE:
  3108.                     .
  3109.                     .
  3110.                     .               
  3111.  
  3112.                     $TERMINATE:
  3113.                     * <Ctrl-C>$
  3114.                     $Goto CONTINUE
  3115.  
  3116.  
  3117.  
  3118.  
  3119.  
  3120.  
  3121.  
  3122.  
  3123.  
  3124.  
  3125.  
  3126.  
  3127.  
  3128.  
  3129.  
  3130.  
  3131.  
  3132.                                     - 54 -
  3133.     EDITING DOS PHANTOM RECORDINGS                               Page 9-21
  3134.     DETECTING EXIT STATUS                                  20 September 92
  3135.  
  3136.  
  3137.     9.14  DETECTING EXIT STATUS
  3138.  
  3139.     Many, if not most, DOS programs return  an  "exit  status"  when  they
  3140.     terminate  indicating  whether  they  were  successful  in  performing
  3141.     whatever function they were supposed to  perform.   The  $IfError  and
  3142.     $IfSuccess  directives  enable  you  to go to a label depending on the
  3143.     exit status of the last program you ran.
  3144.  
  3145.     Here is the  example  from  the  previous  section  re-coded  to  take
  3146.     advantage of these directives:
  3147.  
  3148.                     $LOOP:
  3149.                     * TROJAN
  3150.                     $ExitWait 60
  3151.                     $IfTimeout TERMINATE
  3152.                     $IfSuccess CONTINUE
  3153.                     $IfError LOOP
  3154.  
  3155.                     $CONTINUE:
  3156.                     .
  3157.                     .
  3158.                     .               
  3159.  
  3160.                     $TERMINATE:
  3161.                     * <Ctrl-C>$
  3162.                     $Goto CONTINUE
  3163.  
  3164.  
  3165.     Note that the  $IfSuccess  CONTINUE  is  actually  superfluous,  since
  3166.     execution  would  continue  at  the  CONTINUE  label  anyway.   It was
  3167.     included to demonstrate the use of the directive.
  3168.  
  3169.  
  3170.  
  3171.  
  3172.  
  3173.  
  3174.  
  3175.  
  3176.  
  3177.  
  3178.  
  3179.  
  3180.  
  3181.  
  3182.  
  3183.  
  3184.  
  3185.  
  3186.  
  3187.  
  3188.  
  3189.  
  3190.                                     - 55 -
  3191.     EDITING DOS PHANTOM RECORDINGS                               Page 9-22
  3192.     USING THE $SETMODE DIRECTIVES                          20 September 92
  3193.  
  3194.  
  3195.     9.15  USING THE $SETMODE DIRECTIVES
  3196.  
  3197.     The  $SetMode  directives  could  have  been   called   the   "Prodigy
  3198.     directives"  since  their  usefulness  appears  to  be limited to fast
  3199.     playback into the Prodigy on-line service.  Prodigy uses what may be a
  3200.     unique  method  of  obtaining  characters  from the keyboard which can
  3201.     cause loss  of  characters  during  high-speed  playback.   To  ensure
  3202.     against  this, the $SetMode Func6 directive should be placed after the
  3203.     command which invokes Prodigy, and the $SetMode Normal command  placed
  3204.     just after the command terminating Prodigy.
  3205.  
  3206.     You may not experience difficulties playing back into Prodigy  without
  3207.     these  directives.   If that is the case, ignore this section.  If you
  3208.     do experience character loss playing into  Prodigy,  these  directives
  3209.     should solve the problem.
  3210.  
  3211.     Here is an example of the use of the $SetMode directives where Prodigy
  3212.     is  invoked,  the  stock  price  for  IBM is displayed, and Prodigy is
  3213.     terminated.
  3214.  
  3215.                     * Prodigy
  3216.                     $SetMode Func6
  3217.  
  3218.                     !
  3219.                     ! Prodigy user ID and password
  3220.                     !
  3221.                     * HDCK21B<Tab>PASSWORD
  3222.  
  3223.                     !
  3224.                     ! Jump to quote check
  3225.                     !
  3226.                     * <F6>Quote Check
  3227.  
  3228.                     !
  3229.                     ! Display IBM's current price
  3230.                     !
  3231.                     * IBM
  3232.  
  3233.                     !
  3234.                     ! Give us a chance to read it
  3235.                     !
  3236.                     $Wait 00:30.000
  3237.  
  3238.                     !
  3239.                     ! Leave prodigy
  3240.                     !
  3241.                     * <Shft-Tab><Shft-Tab>
  3242.                     * E
  3243.  
  3244.                     $SetMode Normal
  3245.  
  3246.  
  3247.  
  3248.                                     - 56 -
  3249.     EDITING DOS PHANTOM RECORDINGS                               Page 9-23
  3250.     HINTS AND TIPS                                         20 September 92
  3251.  
  3252.  
  3253.     9.16  HINTS AND TIPS
  3254.  
  3255.     9.16.1  RECOVERING EDITING SESSIONS
  3256.  
  3257.     To recover an aborted editing session with DOS Phantom,  for  example,
  3258.     you should make sure that everything is as it was when you started the
  3259.     recording:  the same files with the same contents,  the  same  default
  3260.     disk and directory, and so on.
  3261.  
  3262.  
  3263.  
  3264.     9.16.2  USING DOS PHANTOM IN BATCH FILES
  3265.  
  3266.     To use DOS Phantom from a batch file, don't use the  /I  command  line
  3267.     switch and end your recordings with the DOS EXIT command.
  3268.  
  3269.  
  3270.  
  3271.     9.16.3  PLAYBACK CHAINING
  3272.  
  3273.     Beginning with version 2.5, during playback you can chain  to  another
  3274.     file by invoking Phantom at the DOS command line from within the first
  3275.     file.  Note that invoking Phantom for recording from within a playback
  3276.     file is *not* supported.
  3277.  
  3278.  
  3279.  
  3280.     9.16.4  DON'T USE THE MOUSE
  3281.  
  3282.     DOS  Phantom  doesn't  record  mouse  activity,  so  you  have  to  do
  3283.     everything you want recorded on the keyboard.
  3284.  
  3285.  
  3286.  
  3287.  
  3288.  
  3289.  
  3290.  
  3291.  
  3292.  
  3293.  
  3294.  
  3295.  
  3296.  
  3297.  
  3298.  
  3299.  
  3300.  
  3301.  
  3302.  
  3303.  
  3304.  
  3305.  
  3306.                                     - 57 -
  3307.  
  3308.  
  3309.  
  3310.  
  3311.  
  3312.  
  3313.  
  3314.  
  3315.  
  3316.  
  3317.  
  3318.  
  3319.                                   CHAPTER 10
  3320.  
  3321.                       DOS PHANTOM TECHNICAL INFORMATION
  3322.  
  3323.  
  3324.  
  3325.     10.1  DOS VERSION REQUIREMENTS
  3326.  
  3327.     DOS Phantom uses features first made available  in  MS-DOS  V3.0,  and
  3328.     will probably not execute properly on prior versions of MS-DOS.
  3329.  
  3330.  
  3331.  
  3332.     10.2  MEMORY USAGE
  3333.  
  3334.     DOS Phantom V2.6, when installed as a TSR, uses approximately  32K  of
  3335.     memory.
  3336.  
  3337.  
  3338.  
  3339.  
  3340.  
  3341.  
  3342.  
  3343.  
  3344.  
  3345.  
  3346.  
  3347.  
  3348.  
  3349.  
  3350.  
  3351.  
  3352.  
  3353.  
  3354.  
  3355.  
  3356.  
  3357.  
  3358.  
  3359.  
  3360.  
  3361.  
  3362.  
  3363.  
  3364.                                     - 58 -
  3365.  
  3366.  
  3367.  
  3368.  
  3369.  
  3370.  
  3371.  
  3372.  
  3373.  
  3374.  
  3375.  
  3376.  
  3377.                                   CHAPTER 11
  3378.  
  3379.                 DIFFERENCES BETWEEN DOS PHANTOM V1.4 AND V2.0
  3380.  
  3381.  
  3382.  
  3383.  
  3384.           o  Program Termination Awareness
  3385.  
  3386.              The new $ExitWait directive allows you to pause DOS Phantom's
  3387.              playback  until  the  currently executing program exits.  You
  3388.              may optionally provide a timeout value after  which  playback
  3389.              will continue event if the program hasn't exited yet.
  3390.  
  3391.              The new $IfSuccess, $IfError, and $IfTimeout directives allow
  3392.              you  to branch to a label in your recording file based on the
  3393.              termination status of the program or on an $ExitWait timeout.
  3394.  
  3395.           o  Screen Awareness
  3396.  
  3397.              The new $MatchWait directive allows you  to  pause  your  DOS
  3398.              Phantom  playback  until a text string you specify appears on
  3399.              the screen.  An optional timeout  value  causes  playback  to
  3400.              continue  if  the  text  string  doesn't appear on the screen
  3401.              within the timeout period.
  3402.  
  3403.              The new $IfMatch  and  $IfTimeout  directives  allow  you  to
  3404.              direct  playback based on whether the text string was matched
  3405.              or not.
  3406.  
  3407.              The new /O command line switch causes DOS  Phantom  to  write
  3408.              text  from the screen to the recording file during recording.
  3409.              When the recording file is processed with PTM2TXT, the screen
  3410.              text  is placed within comments.  This feature is intended to
  3411.              aid you in developing $MatchWait directives.
  3412.  
  3413.           o  Special High Speed Playback Mode
  3414.  
  3415.              The  new  $SetMode  directive  allows  the  highest  possible
  3416.              playback  speed  into  programs such as Prodigy which use DOS
  3417.              function 6 for input.  $SetMode Func6  allows  playback  into
  3418.              Prodigy  at  high  speed  with  no  loss of characters due to
  3419.              prodigy's  "eating"  of  input.   $SetMode  Normal  sets  the
  3420.  
  3421.  
  3422.                                     - 59 -
  3423.     DIFFERENCES BETWEEN DOS PHANTOM V1.4 AND V2.0                Page 11-2
  3424.                                                            20 September 92
  3425.  
  3426.  
  3427.              playback  mode  back to normal.  This is the required setting
  3428.              for most programs.  The new $SetPace directive allows you  to
  3429.              set  a  constant  delay between keystrokes as they are played
  3430.              back.
  3431.  
  3432.           o  Special Abort Hotkey
  3433.  
  3434.              A second hotkey for aborting playback sequences  may  now  be
  3435.              specified on the command line using the /A switch.  The abort
  3436.              key defaults to none.  The abort key, when pressed, is passed
  3437.              on  to  the  program  executing  after aborting DOS Phantom's
  3438.              playback.  Ctrl-C is the most commonly used abort key.
  3439.  
  3440.           o  Disabling of Hotkey
  3441.  
  3442.              Using the command line switch /K=NONE  results  is  disabling
  3443.              the  hotkey  used  for  pauses and displaying the DOS Phantom
  3444.              control panel.  This allows DOS Phantom recordings to be used
  3445.              by  users  unfamiliar  with DOS Phantom without the danger of
  3446.              their inadvertently pausing the playback.
  3447.  
  3448.           o  Changes to /S and /M
  3449.  
  3450.              In addition to the pre-V2.0 toggle functions of the /S and /M
  3451.              command  line  switches,  prefixing  them  with  a minus sign
  3452.              disables the sound or mode display regardless of its  current
  3453.              setting.   Thus,  /-S turns sound off, and /-M turns the mode
  3454.              display off whether or not they were already off.
  3455.  
  3456.           o  Major Change to Record/Playback Functions
  3457.  
  3458.              DOS Phantom V2.0 uses an entirely  new  method  of  obtaining
  3459.              keystrokes  during  record  and  providing  keystrokes during
  3460.              playback.  The new method will work with a greater number  of
  3461.              programs  than  the  older method, and actually resulted in a
  3462.              savings in memory utilization.
  3463.  
  3464.           o  Screen Capture
  3465.  
  3466.              The /F command line option and the $Screen directive allow  a
  3467.              snapshot  of  the  screen  to  be written to a file.  This is
  3468.              useful  when  testing  software  and  when  creating  complex
  3469.              recording  files  which  depend  on  the  screen  contents to
  3470.              determine different paths of execution.
  3471.  
  3472.           o  Print Capture
  3473.  
  3474.              The /V command and $Printer  directives  allow  output  which
  3475.              would normally go to the printer to be re-directed to a file.
  3476.  
  3477.  
  3478.  
  3479.  
  3480.                                     - 60 -
  3481.